如何检查我的字符串是联合类型的一部分

Question

我有一个类型保护，它接受一个字符串，我想知道它是否是联合类型的一部分，但是如果我们在联合类型中添加新字符串，我不想通过添加新字符串来管理我的类型保护：

type GreatAnimal = 'Dog' | 'Cat'

function isGreatAnimal(pet: string): pet is GreatAnimal {
    return pet === 'Dog' || pet === 'Cat'; // Here I would prefer to do something like 'pet keyof GreatAnimal'
}

function Foo(animal:string){
    if (isGreatAnimal(animal)) {
        // do something

    }
    else {
        // do something else
    }
}

如果我在联合类型“GreatAnimal”中添加 Fish，我不想更新我的类型保护来管理 Fish。

我正在使用最后一个打字稿版本

Answer 1

您不能以编程方式使用类型，因为它们不会存在于转译的 JavaScript 代码中。

例如你的代码的第一部分

type GreatAnimal = 'Dog' | 'Cat'

function isGreatAnimal(pet: string): pet is GreatAnimal {
    return pet === 'Dog' || pet === 'Cat';
}

转译为

function isGreatAnimal(pet) {
    return pet === 'Dog' || pet === 'Cat';
}

因此，您需要对GreatAnimals 进行一些编程引用，以便隐式检查它们。有很多方法可以做到这一点 - 一个例子是使用枚举（它被转换为普通对象）：

enum GreatAnimal {
  DOG = "Dog",
  CAT = "Cat"
}

function isGreatAnimal(pet: string): pet is GreatAnimal {
  return pet in Object.values(GreatAnimal);
}

function Foo(animal: string) {
  if (isGreatAnimal(animal)) {
    // do something
  } else {
    // do something else
  }
}

（请注意，此示例使用Object.values，它是 ES2017 的一部分。Internet Explorer 不支持它，而 node 从 v7 开始支持它）

Answer 2

const GreatAnimalList = ['Dog', 'Cat', 'Fish'] as const; // TS3.4 syntax
type GreatAnimal = typeof GreatAnimalList[number]; // 'Dog'|'Cat'|'Fish';

function isGreatAnimal(pet: string): pet is GreatAnimal {
  // return GreatAnimalList.includes(pet)
  return GreatAnimalList.indexOf(pet as GreatAnimal) !== -1
}

function Foo(animal: string) {
  if (isGreatAnimal(animal)) {
    // do something
    console.log('isGreatAnimal true')
  }
  else {
    // do something else
    console.log('isGreatAnimal false')
  }
}

Foo('Dog');      // isGreatAnimal true
Foo('Turtle');   // isGreatAnimal false

明天如果你在GreatAnimalList中添加一个新的动物，它会被自动添加到联合类型GreatAnimal中。并且isGreatAnimal()函数不需要做任何改动。