带有自定义 const 枚举的 Typescript 定义

Question

我正在尝试为库创建 TypeScript 定义文件。

该库有一个方法接受类型为 number 的参数，但该参数只能是一组特定的数字，所以我想让我的定义说它需要一个枚举类型，我使用 const enum 创建。

但是，当我在 .d.ts 中定义我的类时，如下所示:

// definitions/SimpleDefinition.d.ts

/// <reference path="Enums.ts" />

declare class SampleDefinedClass {
    public static SampleMethod(enumArg: Enums.SampleEnum): void;
}

我的枚举是这样的:

// definitions/Enums.ts

export const enum SampleEnum {
    Item1 = 1,
    Item2 = 2
}

我有一个 index.d.ts 将两者结合在一起:

// definitions/index.d.ts

/// <reference path="Enums.ts" />
/// <reference path="SampleDefinition.d.ts" />

编译器告诉我:

../definitions/SampleDefinition.d.ts(4,41): error TS2503: Cannot find namespace 'Enums'.

我尝试在我的 SampleDefinition.d.ts 的顶部添加一个导入，但这导致我的代码文件中的定义没有被正确识别。尽管 Visual Studio 和 Visual Studio 代码不会在实际导入时显示错误。

import Enums = require("./Enums");

Main.ts(6,1): error TS2304: Cannot find name 'SampleDefinedClass'.

我已经尝试了更多的东西，比如使用 AMD 和移动文件，但似乎无法让它工作。有没有办法做到这一点？还是我必须找到另一种方法来做到这一点/放弃？

我创建了一个 GitHub repo有了这个确切的样本。

Answer 1

您的 SampleDefinition.d.ts 没有顶级导入或导出，而 Enum.ts 有。也就是说，Enums 是一个模块，而 SampleDefinition 不是，但您正试图在其中使用 Enums。使用旧的(过时的)术语，SampleDefinition.d.ts 是一个内部模块，Enums 是外部模块，您不能在一个应用程序中混合使用这两者。

有两种方法可以使它们保持一致:

一种方法是将所有内容都放在内部，而不在顶层进行任何导入/导出:

修复了 Enum.ts:将 export 包装在 namespace 中

namespace Enums {
    export const enum SampleEnum {
        Item1 = 1,
        Item2 = 2
    }
}

修复了 Main.ts - 只需删除 import Enums .. 行

/// <reference path="../definitions/index.d.ts" />

console.log(Enums.SampleEnum.Item2);
SampleDefinedClass.SampleMethod(Enums.SampleEnum.Item1);

另一种方式是把所有东西都变成一个模块:

修复了 SampleDefinition.ts :使用 import 而不是 reference 和 export 类而不是声明它:

import Enums = require("./Enums");


export class SampleDefinedClass {
    public static SampleMethod(enumArg: Enums.SampleEnum): void;
}

修复了 Main.ts:同样，import 显式地代替了 reference 的所有内容。这样，您根本不需要 definitions/index.d.ts:

import Enums = require("../definitions/Enums");
import {SampleDefinedClass} from "../definitions/SampleDefinition"


console.log(Enums.SampleEnum.Item2);
SampleDefinedClass.SampleMethod(Enums.SampleEnum.Item1);

选择哪种方式由您决定。主要区别在于，对于模块，您的应用程序将在运行时需要模块加载器。没有模块，它可以编译成一个组合脚本文件。这主要对浏览器很重要(你必须自己提供模块加载器)，为节点编译的模块化代码将使用 require 并且可以正常工作。