导入外部javascript库到Typescript中，以便与node一起使用

Importing external javascript libraries into Typescript for use with node

本文关键字：node 一起 javascript 外部 库到 Typescript 导入      更新时间：2023-09-26

不久前，我们开始使用Typescript + Electron来编写一个基于浏览器的桌面应用程序。然而，加载外部Javascript库通常是一个瓶颈。我们尽可能多地使用typings，它为我们完成了大部分工作，但一些Javascript库(尚未)以这种方式可用。要开始编写新的声明文件，我首先想尝试使用DefinitelyTyped存储库中已经存在的声明文件，而不使用typings。这是abs库的一个简单示例:

tsconfig.json: 

{
"compilerOptions": {
    "module": "commonjs",
    "moduleResolution": "node",
    "noImplicitAny": true,
    "removeComments": true,
    "preserveConstEnums": true,
    "sourceMap": true,
    "types": [
        "node"
    ]
},
"files": [
    "abs.d.ts",
    "abs-tests.ts"
]
}

abs.d.ts: 

// Type definitions for abs 1.1.0
// Project: https://github.com/IonicaBizau/node-abs
// Definitions by: Aya Morisawa <https://github.com/AyaMorisawa>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare module "abs" {
    /**
    * Compute the absolute path of an input.
    * @param input The input path.
    */
    function Abs(input: string): string;
    export default Abs;
}

abs-tests.ts: 

/// <reference path="./abs.d.ts" />
import Abs from 'abs';
const x: string = Abs('/foo');

用node:

转录并运行输出的Javascript文件
npm install @types/node --save-dev;
npm install abs;
tsc -p tsconfig.json;
node abs-tests.js;

已转录的Javascript文件:

"use strict";
var abs_1 = require('abs');
var x = abs_1["default"]('/foo');
//# sourceMappingURL=abs-tests.js.map

节点输出:

<my-path>/abs-tests.js:3
var x = abs_1["default"]('/foo');
            ^
TypeError: abs_1.default is not a function
at Object.<anonymous> (<my-path>/abs-tests.js:3:25)
at Module._compile (module.js:556:32)
at Object.Module._extensions..js (module.js:565:10)
at Module.load (module.js:473:32)
at tryModuleLoad (module.js:432:12)
at Function.Module._load (module.js:424:3)
at Module.runMain (module.js:590:10)
at run (bootstrap_node.js:394:7)
at startup (bootstrap_node.js:149:9)
at bootstrap_node.js:509:3

这只是许多不同库的失败测试之一。这里出了什么问题?是否有可能给一些解释获得Typescript代码与外部Javascript库正确转录，所以它可以在节点中使用?

基本上，export default不打算为这个用例工作。

Typescript有特殊的export =和import = require()语法来处理节点模块。

export =可用于节点模块将单个对象或函数分配给其exports对象时。这就是abs模块在index.js中所做的:

module.exports = abs;

它的类型声明可以这样写:

declare module "abs" {
    /**
    * Compute the absolute path of an input.
    * @param input The input path.
    */
    function Abs(input: string): string;
    export = Abs;
}

并像这样使用

import Abs = require('abs');
const x: string = Abs('/foo');

(旁注:如果它包含在tsconfig.json中的files中，您甚至不需要/// <reference abs. d.s ts)

如果你出于某种原因不得不使用它作为export default，你将无法单独使用typescript -你需要将它编译到es6，并使用另一个转译器，如Babel，它支持export default与node的兼容性。

相关文章：