如何为对象属性过滤函数添加正确的TypeScript类型定义

原函数的JavaScript逻辑可以正确过滤对象属性，但TypeScript类型定义无法精确反映返回值的实际结构，问题出在泛型参数没有捕获具体的包含/排除键，返回值类型被硬指定为原对象类型T。以下是两种可行的修正方案：

方案1：使用函数重载 #

通过重载定义不同参数场景下的返回类型，让TypeScript根据传入的参数自动匹配正确的类型：

// 重载1：传入包含键，返回仅包含指定键的对象类型
export function filterObjKeys<T extends {}, Include extends keyof T>(
  obj: T,
  includeKeys: Include[],
  excludeKeys?: never
): Pick<T, Include>;

// 重载2：传入排除键，返回排除指定键后的对象类型
export function filterObjKeys<T extends {}, Exclude extends keyof T>(
  obj: T,
  includeKeys?: never,
  excludeKeys: Exclude[]
): Omit<T, Exclude>;

// 重载3：无过滤参数，返回原对象类型
export function filterObjKeys<T extends {}>(
  obj: T,
  includeKeys?: never,
  excludeKeys?: never
): T;

// 函数实现（类型断言用any即可，重载已处理类型约束）
export function filterObjKeys<T extends {}, K extends keyof T>(
  obj: T,
  includeKeys: K[] = [],
  excludeKeys: K[] = []
) {
  return Object.fromEntries(
    Object.entries(obj).filter(([k, v]) =>
      includeKeys.length > 0 ? includeKeys.includes(k as K) : !excludeKeys.includes(k as K)
    )
  ) as any;
}

测试示例 #

interface Student {
  firstName: string;
  lastName: string;
  email: string;
  class: number;
}

const student: Student = {
  firstName: 'John',
  lastName: 'Doe',
  email: 'a@b.com',
  class: 3,
};

// 类型为 Pick<Student, 'firstName' | 'lastName'>
const filteredStudentInc = filterObjKeys(student, ['firstName', 'lastName']);

// 类型为 Omit<Student, 'email'>
const filteredStudentExc = filterObjKeys(student, [], ['email']);

// 类型为 Student
const originalStudent = filterObjKeys(student);

方案2：使用条件类型泛型 #

通过泛型参数捕获具体的包含/排除键，结合条件类型动态推导返回类型：

export const filterObjKeys = <
  T extends {},
  Include extends keyof T = never,
  Exclude extends keyof T = never
>(
  obj: T,
  includeKeys: Include[] = [] as Include[],
  excludeKeys: Exclude[] = [] as Exclude[]
): Include extends never ? Omit<T, Exclude> : Pick<T, Include> => {
  return Object.fromEntries(
    Object.entries(obj).filter(([k, v]) =>
      includeKeys.length > 0 
        ? includeKeys.includes(k as Include) 
        : !excludeKeys.includes(k as Exclude)
    )
  ) as Include extends never ? Omit<T, Exclude> : Pick<T, Include>;
};

逻辑说明 #

• 泛型参数Include和Exclude分别捕获传入的包含/排除键，默认值设为never表示未传入对应参数
• 条件类型判断：若传入了includeKeys（Include不为never），则返回Pick<T, Include>；否则返回Omit<T, Exclude>
• 数组参数需要断言为对应泛型类型，避免TypeScript的默认类型推断误差

原代码问题分析 #

1. 泛型K extends keyof T过于宽泛，无法捕获具体的包含/排除键集合，只能表示任意键的子集
2. 返回值硬指定为T，后续的as Omit<T, typeof excludeKeys>无效，因为typeof excludeKeys是数组类型而非键的联合类型
3. 未处理includeKeys和excludeKeys互斥的逻辑场景，导致类型推断模糊

内容的提问来源于stack exchange，提问作者crivella