打字稿 - 属性的允许值

Question

Typescript 中只允许一个属性有多个值的最佳方式是什么？

class Foo {
    public type:string;
    // Possible values for type: ['foo1', 'foo2', 'foo3']

    constructor() {}
}

我想让这些类型成为唯一允许的类型，防止我在扩展 Foo 类时输入错误的类型。

Answer 1

class Foo {
    public type: "foo1" | "foo2" | "foo3";

    constructor() {}
}

或

type MyType = "foo1" | "foo2" | "foo3";

class Foo {
    public type: MyType;

    constructor() {}
}

但这仅在编译时强制执行，而不是在运行时强制执行。
如果您想确保 Foo.type 的值只是这些值之一，那么您需要在运行时检查：

type MyType = "foo1" | "foo2" | "foo3";

class Foo {
    public type: MyType;

    constructor() {}

    setType(type: MyType): void {
        if (["foo1", "foo2", "foo3"].indexOf(type) < 0) {
            throw new Error(`${ type } is not allowed`);
        }

        this.type = type;
    }
}

这叫String Literal Types。

Answer 2

你可以使用enums:

enum MyType {
  Foo1 = 'foo1',
  Foo2 = 'foo2',
}

class FooClass {
  private foo: MyType;

  constructor(foo: MyType) {
    this.foo = foo;
  }
}

let bar = new FooClass(MyType.Foo2);

Typescript Docs

Answer 3

const TYPES = ['a', 'b', 'c'] as const; // TS3.4 syntax
type yourType = typeof TYPES[number]; // 'a'|'b'|'c';