通用函数输入中的键的强制类型

时间:2018-07-23 09:59:27

标签: typescript generics

假设我具有通用功能:

function f<T, K extends keyof T>(obj: T, key: K) {
   ...
}

我想强制使用T[K]的类型,以便执行特定于类型的操作。例如,使用字符串:

function f<T, K extends keyof T>(obj: T, key: K): string {
    return obj[key].toLowerCase();
}

在不将内容投放到any的情况下完全有可能吗?

编辑: 为了明确起见,我正在寻找能够根据结果类型禁止某些键的功能。使用上面的示例,类似:

f({a: 123, b: 'abc'}, 'b') //No errors
f({a: 123, b: 'abc'}, 'a') //Typescript error, T['a'] is not string

2 个答案:

答案 0 :(得分:2)

要将属性名称限制为仅具有string值类型的那些,可以将条件类型与映射类型结合使用:

type StringProperties<T> = { [K in keyof T]: T[K] extends string ? K : never }[keyof T];

declare function f<T>(obj: T, key: StringProperties<T>): string;

f({a: 123, b: 'abc'}, 'b') // No errors
f({a: 123, b: 'abc'}, 'a') // Error: Argument of type '"a"' is not assignable to parameter of type '"b"'.

Playground

答案 1 :(得分:0)

您可以通过添加索引类型来强制属性类型,将所有属性强制为一种类型:

interface AllStringProps {
   [key: string]: string;
}

function f<T extends AllStringProps, K extends keyof T>(obj: T, key: K): string {
    return obj[key].toLowerCase();
}

但是,这限制了您使用接受任何字符串作为属性的索引类型。

要增加一点安全性,您可以将代码段更改为

type AllStringProps<T> = {
   [key in keyof T]: string;
}

function f<T extends AllStringProps<T>, K extends keyof T>(obj: T, key: K): string {
    return obj[key].toLowerCase();
}

在这里,类型AllStringProps强制T中可用的所有键都必须是字符串类型。强制所有可能的属性之前的代码段必须为字符串类型。

在您的用例中,差别不大,但我总是更喜欢尽可能小的约束。

更新为评论中的问题

可以说,我们只想允许T的键的子集。

我们可以先定义要允许的所有键:

type AllowedKeys = { "s1" , "s2" };

type AllStringProps<AllowedKeys> = {
   [key in keyof AllowedKeys]: string;
}

function f<T extends AllStringProps<AllowedKeys>, 
           K extends keyof AllowedKeys>(obj: T, key: K): string {
    return obj[key].toLowerCase();
}

上面的代码段将允许传递以下对象:

let t1 = {
    s1: "Hello",
    s2: "World",
    other: 4
}

但不是这个

let t1 = {
    s1: "Hello",
    s2: 6,
    other: 4
}