如何在打字稿中将类型对象键转换为字符串类型的数组

Question

在打字稿中给出以下输入：

type InputObjectType = {
  a: string
  b: number
  c: {}
}

我怎样才能得到以下类型：

type ObjectKeysArrayType = ['a', 'b', 'c']

到目前为止，我只能做到：

type AllPossibleKeys = (keyof InputObjectType)[]

这给了我["a" | "b" | "c"]，这很接近，但在这种情况下不是我想要的。

我需要一个始终包含给定类型对象中所有键字符串的数组。我知道强制执行此操作的唯一方法，例如，当用户向对象添加新键时，该键也添加到数组中时，就是通过类似这样的方法。

Answer 1

我使用两种方法：

// Option 0: Define type using object
const someTypeExample = {
  a: 1,
  b: 'str',
  c: 'foo' as 'foo'|'bar'
};

type SomeType0 = typeof someTypeExample;


// Option 1: If object stores different types
type SomeType = {
  a: number;
  b: string;
}

const typeVar: SomeType = {
    a: 10,
    b: 'string'
}

// used for typechecking
type SomeTypeKey = keyof SomeType;

// create an array to be used in runtime
// disadvantage is that properties need to be repeated
const keys: SomeTypeKey[] = ['a', 'b']; // type checked
// TODO what I'm missing is:
// const keys = keys<SomeTypeKey>(); that would return ['a', 'b'] during transpiling
// ie. native support of https://github.com/kimamula/ts-transformer-keys 
// which is out of scope for TS: https://github.com/microsoft/TypeScript/issues/13267
let isValidKey = keys.includes('c' as SomeTypeKey)


// Option 2: start from keys array definition, in case all values have the same type

const myKeys = ['foo', 'bar'] as const; // as const does the magic
type MyKey = typeof myKeys[number]; // = 'foo' | 'bar'

type MyMap = Record<MyKey, string>;
type MyMap2 = { [key in MyKey]: string };

Answer 2

不确定您是否仍在此处寻找解决方案，但希望这会有所帮助。

如果你想要的是一个类型，它要求变量是一个字符串数组，只包含与你的对象的键相等的值，那么你列出的应该可以工作。

type InputObjectType = {
  a: string
  b: number
  c: {}
}

type AllPossibleKeys = (keyof InputObjectType)[]

AllPossibleKeys 将是等于("a"|"b"|"c")[] 的类型。这看起来是您所要求的，但有一个警告，我猜您想如何使用它。

const fieldArray1: AllPossibleKeys = ['a', 'b', 'c']; //valid
const fieldArray2: AllPossibleKeys = ['a', 'b', 'c', 'd']; //will throw a Typescript error
const fieldArray3: AllPossibleKeys = ['a', 'b']; //this is also valid though as each member is a valid value

如果你想要一个类型中所有键的数组，我知道没有办法明确地做到这一点。但是，如果您能够使用接口而不是类型，那么您可以执行以下操作：

import { keys } from 'lodash';

interface InputObject = {
  a: string
  b: number
  c: {}
}

class InputObjectStub implements InputObject {
  a = null;
  b = null;
  c = null;
}

const fieldArray1 = keys(new InputObjectStub()); //returns ['a', 'b', 'c']

但请注意，这不会强制执行可选属性。如果您需要这样做，请将您的类定义更改为 class InputObjectStub implements Required<InputObject> {...

编辑：拼写

Answer 3

目前不可能，因为类型信息在运行时不可用。您可以在Typescript Playground 上试用您的代码。当你这样做时，你会发现这段代码：

type InputObjectType = {
  a: string
  b: number
  c: {}
}

被转译为空。将代码转换为 javascript 后，它根本不存在。由于它在运行时不存在，因此无法执行任何运行时操作，例如遍历其属性，甚至打印出来。

Answer 4

试试这个

const object1 = {
  a: 'somestring',
  b: 42,
  c: false
};

console.log(Object.keys(object1));

output: Array ["a", "b", "c"]