You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何实现TypeScript函数返回类型自动补全及键合法性校验

实现带类型推导的TypeScript选项获取函数

需要实现一个函数,根据键获取对象的对应值;如果对应值是函数,则执行该函数并返回结果,同时让代码编辑器能提供正确的自动补全,并且对不存在的键给出警告。现有代码存在类型推导失效的问题:

type defaults = {
  a: "A" | "B" | (() => "A" | "B");
  b: "X" | "Y" | (() => "X" | "Y");
};

const myOpts: defaults = {
  a: () => "A",
  b: () => "X",
};

function option(name: string) {
  if (!myOpts[name]) {
    return null;
  }

  return typeof myOpts[name] === "function"
    ? myOpts[name].call()
    : myOpts[name];
}

console.log(myOpts.a);      // 自动补全正常
console.log(option("a"));   // 完全无自动补全
console.log(option("xyz")); // 应给出不存在的警告!!!

可以通过泛型约束和工具类型实现需求,具体修改如下:

  1. 定义工具类型,用于提取值的最终类型(如果是函数则取返回值,否则直接取值类型):
type UnwrapFn<T> = T extends () => infer R ? R : T;
  1. 修改option函数,使用泛型限制参数只能是defaults的键,并推导返回类型:
function option<K extends keyof defaults>(name: K): UnwrapFn<defaults[K]> {
  const value = myOpts[name];
  return typeof value === "function" ? value() : value;
}

效果说明:

  • 调用option("a")时,编辑器会自动补全合法键("a"、"b"),返回类型自动推导为"A" | "B";
  • 若输入不存在的键如"xyz",TypeScript会直接抛出类型错误,符合需求;
  • 无论值是直接的字面量还是返回字面量的函数,都能正确推导最终的返回类型。

完整代码示例:

type defaults = {
  a: "A" | "B" | (() => "A" | "B");
  b: "X" | "Y" | (() => "X" | "Y");
};

const myOpts: defaults = {
  a: () => "A",
  b: () => "X",
};

type UnwrapFn<T> = T extends () => infer R ? R : T;

function option<K extends keyof defaults>(name: K): UnwrapFn<defaults[K]> {
  const value = myOpts[name];
  return typeof value === "function" ? value() : value;
}

console.log(myOpts.a);      // 自动补全正常
console.log(option("a"));   // 自动补全正常,返回类型为 "A" | "B"
console.log(option("xyz")); // 类型报错:类型“"xyz"”的参数不能赋给类型“keyof defaults”的参数

内容的提问来源于stack exchange,提问作者Andrew

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.17 06:31:15