打字稿将泛型约束为字符串文字类型以用于计算对象属性

Question

我正在尝试编写一个函数，该函数将接受一个字符串文字并返回一个具有单个字段的对象，该字段的名称是该字符串文字。我可以编写一个函数来做我想做的事，但是我不知道如何表达它的参数类型是字符串文字的约束。

我最接近的是使用扩展string 的泛型类型。这允许字符串文字类型，但也允许字符串文字类型和类型 string 的联合，我不想将其传递给我的函数。

如果K 是字符串文字类型，这将编译并执行我想要的操作。请注意，类型断言在 typescript 3.4 中不是必需的，但在 3.5 中是必需的。

function makeObject<K extends string>(key: K): { [P in K]: string } {
  return { [key]: "Hello, World!" } as { [P in K]: string };
}

如果K 不是字符串字面量，则此函数的返回类型将与它返回的值的类型不同。

我能想到的实现这项工作的两条途径是：

• 将 K 限制为仅字符串文字
• 表示返回类型是具有单个字段的对象，其名称是 K 中的值（不太令人满意，但至少函数的类型会诚实）

typescript 的类型系统可以表达这些吗？

如果我删除 typescript 3.5 中的类型断言，我会收到错误：

a.ts:2:3 - error TS2322: Type '{ [x: string]: string; }' is not assignable to type '{ [P in K]: string; }'.

2   return { [key]: "Hello, World!" };

Answer 1

TypeScript 4.2 更新

以下作品：

type StringLiteral<T> = T extends string ? string extends T ? never : T : never;

（不再有效）：TypeScript 4.1 模板字面量类型技巧

编辑：以下内容实际上在 4.2 中中断。 Discussion here

type StringLiteral<T> = T extends `${string & T}` ? T : never;

TS 4.1 引入了template literal types，它允许您将字符串文字转换为其他字符串文字。您可以将字符串文字转换为自身。由于只能模板化文字而不是通用字符串，因此您只需有条件地检查字符串文字是否从自身扩展。

完整示例：

type StringLiteral<T> = T extends `${string & T}` ? T : never;

type CheckLiteral = StringLiteral<'foo'>;  // type is 'foo'
type CheckString = StringLiteral<string>;  // type is never

function makeObject<K>(key: StringLiteral<K>) {
    return { [key]: 'Hello, World!' } as { [P in StringLiteral<K>]: string };
}

const resultWithLiteral = makeObject('hello');  // type is {hello: string;}
let someString = 'prop';
const resultWithString = makeObject(someString); // compiler error.

我认为K 的联合不再是问题，因为不需要缩小makeObject 签名中属性键的类型。如果有的话，这会变得更加灵活。

Answer 2

对于单个字符串文字类型没有任何限制。如果您指定extends string，编译器将推断K 的字符串文字类型，但它也将根据定义允许字符串文字类型的联合（毕竟字符串文字类型的联合集合包含在所有字符串的集合中）

我们可以创建一个自定义错误，如果它检测到字符串文字类型的联合，它会强制 as 调用处于错误状态。可以使用条件类型进行此类检查，确保K 与UnionToIntersection<K> 相同。如果这是真的K 不是联合，因为'a' extends 'a' 但'a' | 'b' 不会扩展'a' & 'b'

type UnionToIntersection<U> =
    (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never

type CheckForUnion<T, TErr, TOk> = [T] extends [UnionToIntersection<T>] ? TOk : TErr

function makeObject<K extends string>(key: K & CheckForUnion<K, never, {}>): { [P in K]: string } {
    return { [key]: "Hello, World!" } as { [P in K]: string };
}

makeObject("a")
makeObject("a" as "a" | "b") // Argument of type '"a" | "b"' is not assignable to parameter of type 'never'