特定字符串值的打字稿数组

Question

我有一个数组

const relations = ['profiles', 'locations', 'change_history']

如果我想创建类似

的界面

interface IParams {
  id: number;
  relations: []string; // how to make this an array of those relations above?
}

我该怎么做？

Answer 1

您基本上在这里有两个选择：

const string enum

• https://www.typescriptlang.org/docs/handbook/enums.html#string-enums（用于在运行时显示字符串值以进行检查）
• https://www.typescriptlang.org/docs/handbook/enums.html#const-enums（为避免一些繁琐的枚举枚举并将代码中的引用替换为字符串文字）

您可以通过以下方式定义const枚举：

const enum Relation {
  profiles = 'profiles', 
  locations = 'locations', 
  change_history = 'change_history'
}

字符串文字类型

• https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types

type Relation = 'profiles' | 'locations' | 'change_history';

和@guijob一样已经指出，这将是您的界面（在两种情况下）：

interface IParams {
  id: number;
  relations: Relation[];
}

当然，您也可以内联此字符串文字类型定义

relations: ('profiles' | 'locations' | 'change_history')[];

但是请注意，不会在运行时检查值！

因此，如果您从编译时未检查的资源中添加数据（例如API或用户输入），则不能保证仅存在那些值。

Answer 2

您可以：

enum Relation {
    profiles: 'profiles', locations: 'locations', change_history: 'change_history'
}

interface IParams {
  id: number;
  relations: Relation[];
}

Answer 3

您可以使用 as const assertions 轻松输入“关系”

const relations = ['profiles', 'locations', 'change_history'] as const

interface IParams {
  id: number;
  relations: typeof relations;
}

作为替代，您可以使用 Array<T>

interface IParams {
  id: number;
  relations: Array<'profiles' | 'locations' | 'change_history'>
}

或者如果您更喜欢其他语法

interface IParams {
  id: number;
  relations: ('profiles' | 'locations' | 'change_history')[]
}