node.js - 导入带有导出枚举的模块时找不到模块错误

Question

我正在尝试导入导出枚举类型的自定义模块。但是，当我尝试使用导出的枚举时，出现此错误 Error: Cannot find module 'Runescape'

如果我不使用枚举(因此 import 语句确实有效)，或者如果我将枚举移到我的主 ts 文件中，则代码可以工作。我尝试过使用编译器选项“preserveConstEnums”

tsconfig.json

{
    "compilerOptions": {
      "resolveJsonModule": true,
      "moduleResolution": "node",
      "esModuleInterop": true,
      "sourceMap": true,
      "outDir": "out",
      "target": "es6"
    }
}

Runescape.ts

declare module 'Runescape' {
...
    /**
    * @description Enum of all Runescape skills
    * @enum
    * @default
    */
    export enum SkillsEnum {
        ATTACK = 'attack',
        STRENGTH = 'strength',
        DEFENSE = 'defense',
        RANGED = 'ranged',
        PRAYER = 'prayer',
        MAGIC = 'magic',
        RUNECRAFT = 'runecraft',
        CONSTRUCTION = 'construction',
        HITPOINTS = 'hitpoints',
        AGILITY = 'agility',
        HERBLORE = 'herblore',
        THIEVING = 'thieving',
        CRAFTING = 'crafting',
        FLETCHING = 'fletching',
        SLAYER = 'slayer',
        HUNTER = 'hunter',
        MINING = 'mining',
        SMITHING = 'smithing',
        FISHING = 'fishing',
        COOKING = 'cooking',
        FIREMAKING = 'firemaking',
        WOODCUTTING = 'woodcutting',
        FARMING = 'farming'
    }
...

我希望能够运行这样的代码

const OSRS_SKILLS_VALUES: string[] = Object.keys(Runescape.SkillsEnum).map(
                (key: string): string => Runescape.SkillsEnum[key]
            )

并且没有抛出模块未找到错误

Answer 1

这是因为 Runescape.ts (至少是您在问题中指定的部分)不是一个模块，它是一个声明模块的文件(并且可能应该被命名为 Runescape .d.ts)。

Runescape.ts 是您的代码还是第三方代码？

如果这是您的代码，并且您有其他代码来生成“Runescape” 模块，您应该将该枚举放入该模块中并导出， typescript 将负责为您生成减速文件。如果您只想创建一个枚举，请直接从“Runescape.ts”导出它(无需模块声明)。

如果这不是你的代码并且你无法修改它，你仍然可以通过告诉 typescript 编译器在哪里找到模块的声明来使用它，你可以通过添加引用指令来完成它(调整实际文件的路径) ，如果需要):

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

然后就可以通过导入模块来使用它了:

import * as Runescape from "Runescape";

const OSRS_SKILLS_VALUES: string[] = Object.keys(Runescape.SkillsEnum).map(
    (key: string): string => Runescape.SkillsEnum[key]
)

或者直接枚举:

import { SkillsEnum } from "Runescape";

const OSRS_SKILLS_VALUES: string[] = Object.keys(SkillsEnum).map(
    (key: string): string => SkillsEnum[key]
)

请注意，在这种情况下，仅仅因为 typescript 可以编译此代码并不意味着它可以执行。因为枚举只是一个声明，所以实际的 javascript 代码将假设已经有一个名为“Runescape”的模块，其中包含该枚举的实际代码(实际上，它是 javascript 等效的，javascript 中没有枚举)。您有责任确保该模块在运行时环境( Node 、浏览器等)中可访问。

为了更好地理解模块和声明文件的概念，您应该阅读 modules 上的 typescript 文档, namespaces and modules以及文档中的其他相关部分。