在导入具有导出枚举的模块时无法找到模块错误

Question

我正在尝试导入一个导出枚举类型的自定义模块。但是，当我尝试使用导出的枚举时，我会得到以下错误Error: Cannot find module 'Runescape'

如果我不使用枚举，所以导入语句确实有效，或者如果我将枚举移动到我的主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“模块，那么您应该将该enum放入并导出到该模块中，类型记录将负责为您生成减速文件。如果您只想创建一个枚举，那么直接从"Runescape.ts“导出它(没有模块声明)。

如果它不是您的代码，并且您不能修改它，您仍然可以通过告诉类型记录编译器在哪里找到模块的声明来使用它，您可以添加一个引用指令(如果需要的话，调整到实际文件的路径)：

/// <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]
)

注意，在这种情况下，仅仅因为类型记录可以编译这段代码并不意味着它可以被执行。因为enum只是一个声明，实际的javascript代码将假定已经有一个名为"Runescape“的模块包含了该枚举的真正代码(实际上，它等同于javascript，javascript中没有枚举)。您有责任在运行时环境(节点、浏览器等)中访问此模块。

为了更好地理解模块和声明文件的概念，您应该阅读模块、命名空间和模块和文档中其他相关部分的类型记录文档。