TypeScript 中的代数数据类型

Question

换一种说法：

您将如何在 TypeScript 中键入 windowState DOM 属性？

已解决（在 TypeScript 2 中）：

declare var windowState: WindowState
const enum WindowState {
  STATE_MAXIMIZED = 1,
  STATE_MINIMIZED = 2,
  STATE_NORMAL = 3,
  STATE_FULLSCREEN = 4
}
...
var windowState = 5 // Type Error, as expected!

原始问题：

我如何在 TypeScript 中使用 declare 和 type 来描述代数数据类型？这样做的目的是描述现有的 API。

当我尝试以下操作时，TypeScript 显然会抱怨 type is expected：

type Weather = 'sunny' | 'bad'

我的一个想法是使用 JavaScript 2015 Symbol，但是 TypeScript 似乎不知道这些。

另一个想法是使用 enum，但是 TypeScript 抱怨 member initializer must be constant expression：

const enum Weather {
  sunny = 'sunny',
  bad = 'bad',
  windy = Symbol('windy')
}

我会认为string 常量是一个常量表达式。

Answer 1

要使用枚举，你可以写一些 like this:

enum Weather {
    Sunny,
    Windy
};

let currently = Weather.Sunny;

字符串字面量

OP 要求解决此问题的另一种方式是到达TypeScript 1.8。

他们会允许你做这样的事情：

type Weather = 'Sunny' | 'Windy';

Answer 2

TypeScript 2.0 支持可区分的联合/代数数据类型。文档是here。

您可以组合字符串文字类型、联合类型、类型保护和类型别名来构建称为可区分联合的高级模式，也称为标记联合或代数数据类型。 可区分联合在函数式编程中很有用。 某些语言会自动为您区分工会； TypeScript 建立在当今存在的 JavaScript 模式之上。 共有三种成分：

1. 具有公共文字（或枚举）属性的类型 - 判别式。
2. 采用这些类型的联合的类型别名 - 联合。
3. 公共属性上的类型保护。

让我们开始吧：

interface Square {
    kind: "square";
    size: number;
}
interface Rectangle {
    kind: "rectangle";
    width: number;
    height: number;
}
interface Circle {
    kind: "circle";
    radius: number;
}

首先我们声明我们将联合的接口。 每个接口都有一个具有不同字符串文字类型的kind 属性。 kind 属性称为 discriminant 或 tag。 其他属性特定于每个接口。 请注意，这些接口当前是不相关的。 让我们把它们放到一个联合中：

type Shape = Square | Rectangle | Circle;

现在让我们使用有区别的联合：

function area(s: Shape) {
    switch (s.kind) {
        case "square": return s.size * s.size;
        case "rectangle": return s.height * s.width;
        case "circle": return Math.PI * s.radius ** 2;
    }
}

在每个分支中，TypeScript 都会缩小类型。 如果您尝试使用 case 子句的值不作为任何 kind 属性出现，那么 TypeScript 将出错。