导入具有导出枚举的模块时找不到模块错误

Posted 2023-03-07

【中文标题】导入具有导出枚举的模块时找不到模块错误

【英文标题】：Cannot find module error when importing a module with exported enums

【发布时间】：2019-12-06 05:41:39

【问题描述】：

我正在尝试导入一个导出枚举类型的自定义模块。但是，当我尝试使用导出的枚举时，我收到此错误 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]
            )

并且不会抛出找不到模块的错误

【问题讨论】：

我遇到了同样的问题，但奇怪的是只有ts-node... VS Code 没有报告任何问题，tsc 可以完美地编译和运行我的代码！

【参考方案1】：

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

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

如果它是您的代码，并且您有其他代码使 “Runescape” 模块，您应该将该枚举放入并导出该模块，打字稿会小心为您生成减速文件。如果你只想创建一个枚举，直接从“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 中没有枚举）。您有责任在运行时环境（节点、浏览器等）中访问此模块。

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