TypeScript如何为类型化对象参数保留自动补全同时允许任意字符串输入

解决方案 #

你之前的方案失效的原因是给原始对象新增索引签名后，TS 在推导键路径时会优先使用泛化的string类型，覆盖了具体的键名字面量，导致补全能力丢失。不需要修改原有的KeyPath类型逻辑，只需调整最终的参数类型即可：

核心修改点 #

利用 TS 的类型特性：如果直接将字面量联合类型和string做联合，TS 会直接把整个类型塌缩为string导致补全失效。我们可以使用string & {}这个兼容 string 但不会触发类型塌缩的特殊类型，和原有的键路径类型做联合：

// 保留你原来的 KeyPath 类型定义不变
type KeyPrefix<T extends string> = T extends "" ? "" : `.${T}`;

export type KeyPath<T> = (
  T extends object
    ? {
        [K in Exclude<keyof T, symbol>]: `${K}${KeyPrefix<KeyPath<T[K]>>}`;
      }[Exclude<keyof T, symbol>]
    : ""
) extends infer D
  ? Extract<D, string>
  : never;

type StaticPath = KeyPath<typeof myjson>;
// 关键修改：联合特殊的 string 兼容类型，不丢失字面量补全
type Path = StaticPath | (string & {});

function foo(key: Path){
    return key
}

效果验证 #

• 输入foo("nam")时依然会弹出name.john、name.doe的自动补全提示
• 传入foo("name.doe")无类型报错
• 传入动态拼接的字符串foo("name." + value)也不会触发类型错误

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