如何在 TypeScript 界面中要求特定字符串

Question

我正在为第三方 js 库创建一个 TypeScript 定义文件。其中一个方法允许选项对象，选项对象的一个属性接受列表中的字符串：“折叠”、“展开”、“结束扩展”和“无”。

我有一个选项对象的接口：

interface IOptions {
  indent_size?: number;
  indent_char?: string;
  brace_style?: // "collapse" | "expand" | "end-expand" | "none"
}

接口是否可以强制执行这一点，因此如果您将IOptions对象与brace_style属性一起包含，它将只允许可接受列表中的字符串？

Answer 1

TS 提供特定字符串值的类型，这些值称为字符串文本类型。

下面是如何使用它们的示例：

type style =  "collapse" | "expand" | "end-expand" | "none";

interface IOptions {
  indent_size?: number;
  indent_char?: string;
  brace_style1?:  "collapse" | "expand" | "end-expand" | "none";
  brace_style2?:  style;
}

// Ok
let obj1: IOptions = {brace_style1: 'collapse'};

// Compile time error:
// Type '"collapsessss"' is not assignable to type '"collapse" | "expand" | "end-expand" | "none" | undefined'.
let obj2: IOptions = {brace_style1: 'collapsessss'};

Answer 2

试试这个

export type ReadingTypes = 'some'|'variants'|'of'|'strings';

export interface IReadings {
   param:ReadingTypes
}

编辑：非常感谢您的赞成票，但是，随着时间的流逝，我发展成为开发人员:)，现在在大多数情况下，我不再推荐这种方法。是的，它仍然有效，但重点是上面的结构与枚举结构非常相似，所以为什么不使用枚举来代替（优点如下）：

export enum ReadingTypes {
    Some = 'some',
    Variants = 'variants',
    Of = 'of',
    Strings = 'strings',
}
export interface IReadings {
   param: ReadingTypes
}

优点：（是的，可能更像恕我直言，我明白，但是，尽管如此）

< li >例如，当您在代码中看到它时，可读性更强

if(item.reading === 'some') {
...
}
// vs 
if(item.reading === ReadingTypes.Some) {
...
}

在第一种情况下，当你读代码的时候，第一眼看不到。读取字段只能包含几个特定的参数，而不能包含任何字符串值。

Answer 3

这是在1.8版本中作为“字符串文字类型”发布的

打字稿中的新增功能 - 字符串文本类型

页面示例：

interface AnimationOptions {
  deltaX: number;
  deltaY: number;
  easing: "ease-in" | "ease-out" | "ease-in-out";
}