使用字符串文字数组作为类型

时间:2019-11-05 16:49:14

标签: typescript class-validator

我想将单个数组const fruits = ['banana', 'apple', 'orange']用作普通数组,并用作type

我应该能够做到这一点: const x: fruits // => only accepts 'banana', 'apple' or 'orange'

并且还可以执行以下操作: @IsIn(fruits)


我尝试将数组声明为<const>,例如:

const fruits = <const>['banana', 'apple', 'orange']
type Fruits = typeof fruits[number] // this evaluates to type: "banana" | "apple" | "orange"

但是@IsIn(fruits)将返回以下错误:

Argument of type 'readonly ["banana", "apple", "orange"]' is not assignable to parameter of type 'any[]'.
  The type 'readonly ["banana", "apple", "orange"]' is 'readonly' and cannot be assigned to the mutable type 'any[]'.ts(2345)

所以我想如果我创建两个数组,一个普通的数组和一个只读的数组,它应该可以工作。所以我尝试了这个:

const fruits = ['banana', 'apple', 'orange']
const fruits_readonly: <const>[...fruits]
type Fruits = typeof fruits_readonly[number]

但是现在Fruits的评估结果是type: string,而不是type: "banana" | "apple" | "orange"

1 个答案:

答案 0 :(得分:1)

const assertions确实会产生带有readonly元素的对象和数组。如果您想获得const断言为您带来的字符串字面量和元组类型的好处,同时又不对readonly进行结果处理,则可以编写一个辅助函数来实现。我称它为mutable()

const mutable = <T>(t: T): { -readonly [K in keyof T]: T[K] } => t

const fruits = mutable(['banana', 'apple', 'orange'] as const);
// const fruits: ["banana", "apple", "orange"]

这将深入一层。如果您有嵌套的对象/数组类型,则可能需要创建DeepMutable类型和deepMutable()辅助函数:

type DeepMutable<T> =
    T extends object ? { -readonly [K in keyof T]: DeepMutable<T[K]> } : T

const deepMutable = <T>(t: T) => t as DeepMutable<T>;

在上述情况下,效果相同

const alsoFruits = deepMutable(['banana', 'apple', 'orange'] as const);
// const alsoFruits: ["banana", "apple", "orange"]

但是区别对于嵌套对象很重要:

const readonlyDeepFruits = {
    yellow: ["banana", "lemon"],
    red: ["cherry", "apple"],
    orange: ["orange", "mango"],
    green: ["lime", "watermelon"]
} as const;
/* const readonlyDeepFruits: {
    readonly yellow: readonly ["banana", "lemon"];
    readonly red: readonly ["cherry", "apple"];
    readonly orange: readonly ["orange", "mango"];
    readonly green: readonly ["lime", "watermelon"];
} */

const partiallyMutableDeepFruits = mutable(readonlyDeepFruits);
/* const partiallyMutableDeepFruits: {
    yellow: readonly ["banana", "lemon"];
    red: readonly ["cherry", "apple"];
    orange: readonly ["orange", "mango"];
    green: readonly ["lime", "watermelon"];
} */

const fullyMutableDeepFruits = deepMutable(readonlyDeepFruits);
/* const fullyMutableDeepFruits: {
    yellow: ["banana", "lemon"];
    red: ["cherry", "apple"];
    orange: ["orange", "mango"];
    green: ["lime", "watermelon"];
} */

好的,希望能有所帮助。祝你好运!

Link to code