如何定义允许对象键或值的类型

Question

我有一堆按对象分组的常量，但我无法正确输入。 我希望能够使用字符串或通过访问对象来传递对象属性。

我想要什么：

export const ACTIONS = {
    SOMETHING: 'SOMETHING',
    // ...
}

export function example(keyOrValue:  SomeTypeDefThatWorks) {
    // ...
}

example('SOMETHING') // valid
example(ACTIONS.SOMETHING) // valid
example('') // invalid

我到目前为止的尝试：

export const ACTIONS = {
    SOMETHING: 'SOMETHING',
}

export type ActionsType = typeof ACTIONS
export type ActionValues = ActionsType[keyof ActionsType]

export function example1(keyOrValue:  keyof ActionsType) {
    // ...
}
example1('') // invalid
example1('SOMETHING') // valid
example1(ACTIONS.SOMETHING) // invalid

export function example2(keyOrValue:  ActionsType[keyof ActionsType]) {
    // ...
}

example2('') // valid but should not be
example2('SOMETHING') // valid
example2(ACTIONS.SOMETHING) // valid

export function example3(keyOrValue:  keyof ActionsType | ActionsType[keyof ActionsType]) {
    // ...
}

example3('') // valid but should not be
example3('SOMETHING') // valid
example3(ACTIONS.SOMETHING) // valid


// This one works, but is it possible to have this in an object?
export const SOMETHING = 'SOMETHING'
export function example4(keyOrValue: typeof SOMETHING) {
    // ...
}

example4('') // invalid
example4('SOMETHING') // valid
example4(SOMETHING) // valid

有没有办法为对象的键或值定义类型？ 如果是这样，如何？

Answer 1

主要问题是编译器推断ACTIONS对象的类型为{SOMETHING: string} ，并且完全忘记了SOMETHING属性的字符串文字类型。 然后，您的ActionValues类型变为string ，并且您接受所有您不想做的string值。 编译器（合理地）不会假设SOMETHING属性的值将永远保持不变。 是的， ACTIONS本身是一个const ，因此您永远不能为ACTIONS变量分配一个新值，但它的属性仍然是可变的，并且编译器假定它可以采用任何string值。

如果您希望编译器认为ACTIONS本质上是不可变的，并且它应该推断出可能的最窄类型，则可以在声明它时使用const断言：

export const ACTIONS = {
  SOMETHING: 'SOMETHING',
} as const;

现在ACTIONS的类型被推断为{ readonly SOMETHING: "SOMETHING"; } { readonly SOMETHING: "SOMETHING"; } ，你的代码的其余部分经过根据需要：

export type ActionsType = typeof ACTIONS
export type ActionValues = ActionsType[keyof ActionsType]
export function example(keyOrValue: ActionValues) {
  // ...
}

example('SOMETHING') // valid
example(ACTIONS.SOMETHING) // valid
example('') // error!
//      ~~
// Argument of type '""' is not assignable to parameter of type '"SOMETHING"'

好的，希望有帮助； 祝你好运！

Playground 链接到代码