如何在TypeScript中使用无类型的JS NPM模块用于节点?

时间:2017-09-25 21:51:58

标签: javascript node.js typescript npm

我刚开始尝试使用TypeScript,我有以下项目结构:

-src
| index.ts
| MyClass.ts
-node_modules
 -npm_js_module
 | index.js
 | utils.js
 - src
  | someModuleFile.js
  | someModuleFile2.js

我需要在MyClass.ts中使用npm_js_module / index.js(和pm_js_module / src中的函数,但这些是index.js需要的函数)。此模块是无类型的,并且其他人无法在线输入。甚至可以在打字稿项目中使用无类型的JavaScript NPM模块吗?

当我尝试编译此项目时,我收到此错误:

error TS6059: File '/node_modules/npm_js_module/index.js' is not under 'rootDir' '/src'. 'rootDir' is expected to contain all source files.
error TS6059: File '/node_modules/npm_js_module/utils.js'' is not under 'rootDir' '/src'. 'rootDir' is expected to contain all source files.

我的tsconfig.json看起来像这样:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "module": "commonjs",
    "target": "es2017",
    "outDir": "./bin",
    "rootDir": "./src",
    "sourceMap": true,
    "allowJs" : true,
    "baseUrl" : "./",
    "paths": {
      "*" : ["./node_modules/@types/*", "*"]
    }
  },
  "files": [
    "./node_modules/@types/node/index.d.ts",
    "./node_modules/npm_js_module/index.js"
  ],
  "include": [
    "src/**/*.ts",
    "./node_modules/npm_js_module/*"
  ],
  "exclude": [
    "./node_modules"
  ]
}

和package.json像这样:

{
  "name": "myproject",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@types/node": "^8.0.30"
  },
  "dependencies": {
    "npm_js_module": "^1.2.3"
  }
}

我正在使用这种方式导入该模块:import * as mymodule from 'npm_js_module';其中VScode在代码中显示此错误:Property 'login' does not exist on type '(loginData: any, options: any, callback: any) => void'.当我尝试编译时,会出现如上所述的错误。

2 个答案:

答案 0 :(得分:3)

它不是很清楚但它隐藏在文档中:

Modules

如果向下滚动,您会看到标有以下内容的部分: export = and import = require()

  

使用export =导入模块时,必须使用TypeScript特定的import module = require(" module")导入模块。

这显示了一个例子:

import zip = require("./ZipCodeValidator");

希望这有帮助。

答案 1 :(得分:1)

对于您的问题,有3种可能的解决方案。

  1. 使用普通的Javascript import jsModule = require('npm_js_module');
  2. 为您的模块创建一个虚拟定义并手动包含它。
  3. 最佳方式:创建正确的定义并向官方存储库发送拉取请求。
  4. 第一个解决方案应该适合您,只需将其作为普通的node.js模块。 (如果您使用的是最新版本的节点8.5,您可以通过激活特殊标记node --experimental-modules main.mjs来使用ES6导入样式)但我不推荐它,因为它没有被确认..