我可以导入* .d.ts而不是需要它吗?

时间:2016-12-03 16:02:40

标签: typescript typescript-typings

我在lib中有一些模块node_modules,我想使用它。 我为此写了lib.d.ts

文件看起来像:

/src/
    main.ts (imports `lib`)
/types/
    lib.d.ts

在文件main.ts中,我可以编写此代码:

/// <reference path="../types/lib.d.ts" />
import {some} from 'lib';

它有效。

但是当我尝试将import用于环境声明文件时:

import '../types/lib';
import {some} from 'lib';

它编译没有错误,但在生成的JS中我可以找到此文件的require:

require('../types/lib');
const lib_1 = require('lib');

错误文件../types/lib的运行时出错 - 它只是一个没有生成文件的环境声明文件。

为什么编译器没有删除* .d.ts文件的导入?
我可以以某种方式使用导入,或者我必须使用引用吗?

解决方案:

如果您不想使用reference指令, 你只需要在文件中添加所需的* .d.ts, 包含在你的tsconfig.json中。

我的tsconfig.json是:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es2015",
        "lib": ["es2016"],
        "noImplicitAny": true,
        "noImplicitReturns": true,
        "noImplicitThis": true,
        "strictNullChecks": true,
        "noFallthroughCasesInSwitch": true,
        "noUnusedLocals": true,
        "noUnusedParameters": true,
        "noEmitOnError": true,
        "newLine": "LF",
        "forceConsistentCasingInFileNames": true,
        "removeComments": true,
        "declaration": false,
        "sourceMap": false,
        "outDir": "../build",
        "types": [
            "node"
        ]
    },
    "files": [
        "index.ts"
    ]
}

早期我尝试将我的.d.ts添加到types部分,但在这种情况下 tcs正试图在node_modules / @ types目录中找到这个文件。

建议后我尝试在files部分添加文件:

    "files": [
        "index.ts",
        "types/lib.d.ts"
    ]

它起作用并且似乎是一个很好的解决方案。

1 个答案:

答案 0 :(得分:5)

您不必import环境定义文件。

您可以手动/// <reference它。但正确的方法是通过文件tsconfig.json将其提供给编译器。

tsconfig.json的示例,其中包含node_modules以外的任何内容:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es5"
    },
    "exclude": [
        "node_modules"
    ]
}

documentation on tsconfig.json is here