是否可以在 TypeScript 的类中定义类型（字符串文字联合）？答案

【问题标题】：Is it possible to define a type (string literal union) within a class in TypeScript?是否可以在 TypeScript 的类中定义类型（字符串文字联合）？
【发布时间】：2016-07-22 19:02:13
【问题描述】：

在 TypeScript 1.8 中，他们添加了一种称为“字符串文字类型”的新类型，它允许您声明只能是一组有限值之一的类型。他们给出的例子是：

type Easing = "ease-in" | "ease-out" | "ease-in-out";

但是，在他们的所有示例中，类型要么在其使用的类的外部定义，要么在没有别名的情况下内联定义。正如this question 的答案中所解释的（相当简洁），类型别名声明的范围仅限于它们的包含模块。

在我的项目中，我想为与特定类配对并在多个地方使用的字符串文字定义类型别名。由于我使用的 API 的结构，有多个类，每个类都具有相同名称但不同的潜在值的属性。如果可以的话，我想保持我的代码整洁，不要有一堆带前缀的全局类型声明（MyClassAPropertyValue、MyClassBPropertyValue 等）。

那么，有没有办法在类范围内声明 type（最好是可以从外部模块中使用）？ 如果没有，是否有一个紧密的替代或计划的功能将填写这个用例？

用例：

假设我有两个类来包装我的底层 API 数据。每个类代表不同的数据，它们恰好有一些同名的属性。我想要一种定义属性的方法，如下所示：

export class APIObjectA {
    // Valid values in APIObjectA
    public type Property1Value = "possible_value_A" | "possible_value_B";
    public type Property2Value = "possible_value_C" | "possible_value_D";

    // Here, "Property1Value" refers to the version in APIObjectA
    public get property1(): Property1Value {
        // Return value of property1 from underlying API data
    }

    public get property2(): Property2Value {
        // ...
    }
}

export class APIObjectB {
    // Valid values in APIObjectB
    public type Property1Value = "possible_value_E" | "possible_value_F";
    public type Property2Value = "possible_value_G" | "possible_value_H";

    // In this context, "Property1Value" refers to the version in APIObjectB
    public get property1(): Property1Value {
        // ...
    }

    public get property2(): Property2Value {
        // ...
    }
}

然后，理想情况下，我可以在消费代码中引用特定类型，以便我在任何地方都有类型：

var myNewValue: APIObjectB.Property1Value = "possible_value_F";

【问题讨论】：

我想我明白你在问什么，但你能添加一些代码作为你打算如何使用这种类型的例子吗？

标签： types typescript typescript1.8

【解决方案1】：

您不能直接在类中定义类型（无论是嵌套类、枚举还是字符串字面量类型）。

但是，如this answer 所示，您可以通过在同名模块中定义嵌套类型来解决此问题。

export class APIObjectA {
    // Here, "Property1Value" refers to the version in APIObjectA
    public get property1(): APIObjectA.Property1Value {
        // Return value of property1 from underlying API data
    }

    public get property2(): APIObjectA.Property2Value {
        // ...
    }
}

module APIObjectA {
    // Valid values in APIObjectA
    export type Property1Value = "possible_value_A" | "possible_value_B";
    export type Property2Value = "possible_value_C" | "possible_value_D";
}

export class APIObjectB {
    // In this context, "Property1Value" refers to the version in APIObjectB
    public get property1(): APIObjectB.Property1Value {
        // ...
    }

    public get property2(): APIObjectB.Property2Value {
        // ...
    }
}

module APIObjectB {
    // Valid values in APIObjectB
    export type Property1Value = "possible_value_E" | "possible_value_F";
    export type Property2Value = "possible_value_G" | "possible_value_H";
}

请注意，您需要为属性的返回类型使用完全限定名称。例如，您需要使用APIObjectB.Property1Value 而不仅仅是Property1Value。

【讨论】：