如何让TypeScript根据数组长度约束函数的参数数量？

需求 #

实现函数 myFunction(param) { ... }，并添加类型定义，使得调用时：

myFunction({ 
   args: ['arg1', 'arg2'],
   method: (param1: string, param2: string) => { }
})

TypeScript能自动约束method的参数数量与args数组的元素数量完全一致。

解决方案 #

利用TypeScript的泛型元组特性，可以精准关联args和method的参数结构：

// 定义参数类型，通过泛型T关联args和method的参数
type MyFunctionOptions<T extends readonly any[]> = {
  args: T;
  method: (...params: T) => void;
};

// 实现函数，传入泛型约束的参数
function myFunction<T extends readonly any[]>(options: MyFunctionOptions<T>) {
  // 示例逻辑：调用method并传入args
  options.method(...options.args);
}

效果验证 #

合法调用（参数数量匹配） #

以下代码会通过TypeScript类型检查：

// 两个参数的情况
myFunction({ 
  args: ['arg1', 'arg2'],
  method: (param1: string, param2: string) => {}
});

// 三个参数的情况
myFunction({ 
  args: [100, true, "test"],
  method: (num: number, flag: boolean, str: string) => {}
});

非法调用（参数数量不匹配） #

以下代码会触发TypeScript编译错误：

// method参数数量少于args元素数量
myFunction({ 
  args: ['arg1', 'arg2'],
  method: (param1: string) => {}
});

// method参数数量多于args元素数量
myFunction({ 
  args: [100],
  method: (num: number, extra: string) => {}
});

原理说明 #

• 泛型T被约束为只读元组，用来捕获args数组的具体元素类型和长度
• method的参数列表被定义为(...params: T)，强制要求其参数数量、类型与args完全对齐
• 编译阶段TypeScript会自动校验两者的匹配性，不满足时直接抛出类型错误

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