如何为内部 JavaScript 模块创建 .d.ts 文件

Question

我有一个使用 json 文件进行配置的 JavaScript 项目。 加载哪个配置文件由环境变量决定，所以我有一个包装文件config.js ，它加载正确的 json 文件并将其导出为常量。

我正在使用 VS Code，并想创建一个声明文件，以便获得智能感知。 我对 TypeScript 不够熟悉，不知道正确的文件结构，也不知道如何将我的 config.js 文件与导出的接口（或模块或命名空间？）相关联。

这是我所拥有的简化版本。 据我所知，VS Code 不知道将config.d.ts与config.js的导出关联起来。

/config/config.json

{
    "setting1": {
        "prop1": "foo",
        "prop2": 123
    },
    "setting2": [ "a", "b", "c" ]
}

/src/config.js

import fs from 'fs';
import path from 'path';

const config = JSON.parse(fs.readFileSync(path.join('..', 'config', 'config.json')));

// do some stuff to `config`

export default config;

/src/config.d.ts

export namespace config {
    export const setting1: {
            prop1: string,
            prop2: number
        },
        setting2: string[]
    }
}

Answer 1

您的config.d.ts应如下所示以匹配config.js的结构：

const config: {
    setting1: {
        prop1: string,
        prop2: number
    },
    setting2: string[]
};
export default config;

请注意， config常量声明的类型与配置文件的结构相匹配，并且export default部分是相同的。 将config.d.ts文件与config.js放在同一目录中应该足以让 TypeScript 找到它。 如果这不起作用，请添加您在问题中遇到的确切错误。