如何在TypeScript中定义支持可选额外参数的Nest.js服务接口？

要让performSingleOrFail能适配带有任意额外参数的findAll方法，我们可以通过泛型+剩余参数来定义灵活的类型约束，既保证类型安全，又支持参数的扩展性。

1. 重新定义FindCapable泛型接口 #

将FindCapable改为泛型接口，用来捕获findAll的查询参数类型、额外参数类型以及返回的数组元素类型：

interface FindCapable<Query = any, ExtraArgs extends any[] = any[], T = any> {
  findAll(query: Query, ...extraArgs: ExtraArgs): Promise<T[]>;
}

• Query：findAll第一个查询参数的类型（替换原来的any，可自定义具体类型）
• ExtraArgs：findAll第一个参数之后的所有额外参数组成的数组类型，用any[]约束保证支持任意数量、任意类型的额外参数
• T：findAll返回的数组中单个元素的类型，让singleOrFail的返回类型更精准

2. 改造performSingleOrFail函数 #

利用泛型约束和剩余参数语法，让函数能接收并传递findAll的所有参数：

export const performSingleOrFail = async <Query, ExtraArgs extends any[], T>(
  parent: FindCapable<Query, ExtraArgs, T>,
  query: Query,
  ...extraArgs: ExtraArgs
): Promise<T> => {
  const result = await parent.findAll(query, ...extraArgs);
  
  if (!result || result.length === 0) {
    throw new Error('Record not found');
  }
  if (result.length > 1) {
    throw new Error('More than one record found');
  }
  
  return result[0];
};

这里通过...extraArgs接收所有额外参数，并原样传递给parent.findAll，同时通过泛型保证参数类型和findAll完全匹配。

3. 使用示例 #

带单个额外参数的场景 #

// 假设的用户类型
type User = {
  id: number;
  name: string;
  hiddenField?: string;
};

export class UsersService {
  async findAll(query: any, includeHidden: boolean): Promise<User[]> {
    console.log("是否包含隐藏字段:", includeHidden);
    // 实际业务实现
    return [];
  }

  async singleOrFail(query: any, includeHidden: boolean): Promise<User> {
    return await performSingleOrFail(this, query, includeHidden);
  }
}

带多个额外参数的场景（比如ClientSession+其他标志） #

// 假设的会话类型
type ClientSession = {
  sessionId: string;
  expiresAt: Date;
};

export class OrdersService {
  async findAll(query: { status?: string }, session: ClientSession, skipValidation: boolean): Promise<Order[]> {
    // 使用session和skipValidation参数的业务逻辑
    return [];
  }

  async singleOrFail(query: { status?: string }, session: ClientSession, skipValidation: boolean): Promise<Order> {
    return await performSingleOrFail(this, query, session, skipValidation);
  }
}

type Order = {
  id: string;
  status: string;
  amount: number;
};

TypeScript会自动推断服务类符合FindCapable的结构约束，不需要显式声明implements，同时保证singleOrFail的参数和返回类型与findAll完全匹配。

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