如何用TypeScript模板字面量类型实现on方法空格分隔多事件类型校验
实现方案
可以通过TypeScript的递归模板字面量类型实现空格分隔多事件名的类型校验,完整实现逻辑如下:
步骤1:提取基础事件联合类型
首先从给定的Events元组中提取所有合法的单个事件名联合类型:
type Events = ['error', 'config', 'ready'] type EventName = Events[number] // 推导得到:type EventName = 'error' | 'config' | 'ready'
步骤2:定义递归的多事件组合类型
通过递归模板字面量生成所有合法的空格分隔事件组合,默认支持任意顺序、不重复的事件拼接:
type ValidEventStrings<T extends string = EventName, All extends string = T> = T extends string ? T | `${T} ${ValidEventStrings<Exclude<All, T>>}` : never
如果业务允许重复传入同一个事件名(比如'error error'的写法),可以简化为以下版本:
type ValidEventStrings<T extends string = EventName> = | T | `${T} ${ValidEventStrings<T>}`
步骤3:替换on方法的参数类型
将原on方法的event参数类型替换为上面定义的ValidEventStrings即可:
// 示例Listener定义,可根据实际业务调整入参出项 type Listener = (data: any) => any // 声明api的on方法类型 interface API { on(event: ValidEventStrings, listener: Listener): void } declare const api: API
校验效果测试
// ✅ 合法写法,无类型报错 api.on('error', () => {}) api.on('error config', () => {}) api.on('config error ready', () => {}) // ❌ 非法写法,TS自动抛出类型错误 api.on('error invalidEvent', () => {}) // 包含不存在的事件名 api.on('error config', () => {}) // 包含连续多空格,如需支持可额外加Trim逻辑处理
内容的提问来源于stack exchange,提问作者user16195583
相关产品推荐
相关产品推荐

