TypeScript如何定义匹配实体字段类型的泛型Filter过滤类型
TypeScript 泛型 Filter 类型实现方案
核心思路是通过映射类型遍历实体的每一个字段,将字段名、运算符、字段值三者的类型做绑定,实现精准的类型约束。
完整实现代码
export interface Entity { id: number; isActive: boolean; } // 分类定义运算符类型 // 单值运算符:要求传入对应字段类型的标量值 type SingleValueOp = 'eq' | 'noteq' | 'gt' | 'gte' | 'lt' | 'lte' | 'beginsWith' | 'endsWith' | 'contains'; // 多值运算符:要求传入对应字段类型的数组 type MultiValueOp = 'in' | 'notIn'; // 无值运算符:不允许传入value属性 type NoValueOp = 'exists' | 'notExists'; // 为单个字段生成所有合法的过滤配置组合 type FieldFilterItem<T, K extends keyof T> = | { op: SingleValueOp; field: K; value: T[K] } | { op: MultiValueOp; field: K; value: T[K][] } | { op: NoValueOp; field: K }; // 实体所有字段的过滤配置联合类型 type FieldFilter<T extends Entity> = { [K in keyof T]: FieldFilterItem<T, K> }[keyof T]; // 分组过滤类型(逻辑与/或) interface GroupingFilter<T extends Entity> { op: 'AND' | 'OR'; items: Filter<T>[]; } // 最终导出的Filter泛型类型 export type Filter<T extends Entity> = FieldFilter<T> | GroupingFilter<T>;
效果验证
以上实现完全匹配约束要求:
- 所有合法写法全部可以通过类型校验,和给出的示例完全一致
- 非法写法会触发类型报错:
- 单值运算符传入非对应字段类型的标量会报错
- 多值运算符传入非数组、或数组元素类型不匹配字段类型会报错
- 无值运算符传入value属性会报错
- 字段名不存在于实体属性中会报错
如果需要调整运算符的命名,直接修改对应运算符类型的字面量即可。
内容的提问来源于stack exchange,提问作者Bart van den Burg
相关产品推荐
相关产品推荐

