如何指定Typescript通用T [K]是数字类型?

时间:2019-03-08 09:36:54

标签: typescript generics keyof

我有一个简单的Typescript函数,如下所示:

function getProperty<T, K extends keyof T>(obj: T, key: K): number {
  return obj[key]; // This line is not compiling.
  // Typescript will yell: "Type 'T[K]' is not assignable to type 'number'."
}

我的用法如下:

const someObj = {
  myValue: 123,
  otherProperty: '321'
}

getProperty(someObj, 'myValue')

我不知道someObj的结构是什么。

我的问题是:如何指定T[K]是静态数字类型?

2 个答案:

答案 0 :(得分:1)

  

我不知道someObj的结构是什么。

然后TypeScript并不能真正帮助您。 TypeScript的类型检查在编译时进行。如果someObj的结构仅在 runtime 时才知道,则TypeScript无法访问该结构的类型安全。您需要知道在编译时有哪些属性键和这些属性的可能值。

例如:在您的示例中,属性名称是字符串,而属性值是字符串或数字(但不是布尔值或对象等)。您可以声明由字符串索引的类型(因为所有属性名称最终都是字符串或符号,在这种情况下为字符串),其中属性值是数字或字符串:

declare type SomeObjType = {
    [key: string]: number | string
};

然后getProperty是:

function getProperty<T extends SomeObjType>(obj: T, key: string): number | string {
  return obj[key];
}

,您可以像这样使用它(在这种情况下,我使用JSON.parse模拟从程序范围之外接收此数据):

const someObj: SomeObjType = JSON.parse(`{
  "myValue": 123,
  "otherProperty": "321"
}`);

console.log(getProperty(someObj, 'myValue'));
console.log(getProperty(someObj, 'otherProperty'));

On the playground

但这并不会给您带来太多好处,并且消除了属性值不是数字或字符串的可能性。

您可能只需要使用object

function getProperty(obj: object, key: string) {
  return obj[key];
}

const someObj = JSON.parse(`{
  "myValue": 123,
  "otherProperty": "321"
}`);

console.log(getProperty(someObj, 'myValue'));
console.log(getProperty(someObj, 'otherProperty'));

On the playground

答案 1 :(得分:1)

如果您正在处理的对象的类型足以让打字稿知道它们的形状,那么您完全可以这样做 [typescript playgrounds link,如果您想进行一些实验]。

您只需要将哪些标识符 key 可以是该引用 number 类型属性之一:

const someObj = {
  myValue: 123,
  otherProperty: '321'
};

getProperty(someObj, 'myValue'); //       works
getProperty(someObj, 'otherProperty'); // wails

function getProperty<T, K extends NumericProps<T>>(obj: T, key: K): number {
    return obj[key];
}

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