不久前,我们开始使用Typescript + Electron编写基于浏览器的桌面应用程序。但是,加载外部Javascript库通常是一个瓶颈。我们尽可能多地使用typings
,它为我们完成了大部分工作,但是某些Javascript库还没有(现在)可用。
要开始编写新的声明文件,我首先要尝试使用DefinitelyTyped repository中没有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');
使用节点转录并运行输出的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
这只是许多不同库失败的测试之一。这里出了什么问题?是否可以通过正确转录外部Javascript库来获取Typescript代码的一些解释,以便它可以在节点中使用?
答案 0 :(得分:1)
基本上,export default
并不适用于此用例。
Typescript具有特殊的export =
和import = require()
syntax来处理节点模块。
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中的/// <reference
中,你甚至不需要files
abs.d.ts
如果由于某种原因必须将其用作export default
,您将无法单独使用打字稿 - 您需要将其编译为es6并使用另一个支持{Babel的转发器}来支持{ {1}}与节点的兼容性。您可以在此typescript issue和此blog post中找到详细信息。