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

Question

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

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

然而，当我在 .d.ts 中定义我的 class 时，像这样：

// 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 和移动文件，但似乎无法正常工作。有没有办法做到这一点？或者我必须找到另一种方法来做 it/give 吗？

我用这个确切的示例创建了一个 GitHub repo。

Answer 1

在定义文件中，您必须使用 declare.

导出枚举

我从 DefinitelyTyped 中查找了一些示例，这里是一个：

export declare enum EDeflateStrategy {
    DEFAULT_STRATEGY = 0,
    FILTERED = 1,
    HUFFMAN_ONLY = 2,
    RLE = 3,
    FIXED = 4,
}

您的代码存在问题，您的定义文件似乎在查看 .ts 文件而不是另一个 .d.ts 文件。

如果这是你的库并且它是用 ts 编写的，你可以添加

"declaration": true

在你的 tsconfig.json 文件上，让 tsc 为你生成定义。

如果不是，您可以尝试在 ts 中模拟此库中的内容，并通过启用此选项让 tsc 为您生成声明。

Answer 2

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

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

一种方法 是将所有内容都放在内部，顶层没有任何 import/export：

已修复 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 class 而不是声明它:

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 并且工作得很好。

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

Typescript definition with custom const enum

commonjs

typescript

typescript-typings