如何让TypeScript函数根据入参返回对应长度的类型安全元组？

问题背景 #

我有一个生成测试数据的TypeScript函数，代码如下：

interface User {
    person: string;
}
declare function createUser(): Promise<User>;

async function generateTestUsers(userCount = 2): Promise<User[]> {
  const result: User[] = [];
  for (let i = 0; i < userCount; i++) {
    const user = await createUser();
    result.push(user);
  }
  return result;
}

调用时会从返回的数组中解构用户：

should('do something with some users', async () => {
  const [user1, user2] = await generateTestUsers(2);
  // 执行测试逻辑
});

当前运行正常，但存在隐患：如果开发者修改userCount参数值却未同步调整解构的变量数量，会引发错误。请问能否让generateTestUsers函数根据传入的参数值返回对应元素数量的元组？

解决方案 #

可以通过TypeScript的泛型结合数字字面量类型实现需求，让函数返回类型与传入的userCount参数强绑定，具体实现如下：

1. 定义递归泛型工具类型生成指定长度的元组 #

首先需要一个工具类型，用于根据指定数字生成对应长度的User元组：

type TupleOf<T, N extends number, R extends T[] = []> = 
  R['length'] extends N ? R : TupleOf<T, N, [...R, T]>;

该类型会递归构建元组，直到元组长度等于传入的数字N。

2. 修改函数的类型签名与实现 #

将generateTestUsers改为泛型函数，让userCount接受数字字面量类型，并返回对应长度元组的Promise：

async function generateTestUsers<N extends number>(
  userCount: N = 2 as N
): Promise<TupleOf<User, N>> {
  const result: User[] = [];
  for (let i = 0; i < userCount; i++) {
    const user = await createUser();
    result.push(user);
  }
  // 用类型断言告知TypeScript数组符合目标元组类型
  return result as TupleOf<User, N>;
}

这里默认参数2需要通过as N适配泛型类型，由于运行时数组无法直接被TypeScript推断为元组，因此需要类型断言完成转换。

3. 类型检查效果 #

现在调用函数时，TypeScript会严格校验解构变量数量与userCount是否匹配：

// 合法：传入2，解构2个变量
should('do something with some users', async () => {
  const [user1, user2] = await generateTestUsers(2);
  // 测试逻辑
});

// 报错：传入3但仅解构2个变量（开启严格类型检查时）
should('test with 3 users', async () => {
  const [user1, user2] = await generateTestUsers(3);
  // TypeScript提示：元组类型TupleOf<User, 3>长度为3，但此处需要2个元素
});

// 合法：使用默认值2，解构2个变量
should('test with default users', async () => {
  const [user1, user2] = await generateTestUsers();
});

注意事项 #

• 该方案依赖TypeScript的数字字面量类型和递归泛型特性，要求TypeScript版本≥3.4。
• 运行时无法完全保证元组长度与参数一致（例如createUser抛出异常导致循环中断），但类型层面的约束已能解决开发者修改参数后忘记调整解构变量的问题。

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