node.js - 创建一个 TypeScript 库并将其从 Node.js 与 ES6 和 TypeScript 一起使用
问题描述
我想创建一个 TypeScript 库作为可以在 Node.js 中使用的私有 npm 包(包括6.x)
使用@types
支持的 ES6 和 TypeScript。
该库的目标是扩展Request
类型express
并提供附加属性。
我创建了一个新的 Node.js 项目并添加了这个tsconfig.json
:
{
"compilerOptions": {
"target": "es2015",
"module": "commonjs",
"sourceMap": true,
"declaration": true,
"outDir": "./dist",
"strict": true,
"types": ["mocha"]
}
}
这些是 的相关部分package.json
:
{
"name": "@myscope/my-lib",
"main": "dist",
"scripts": {
"build": "rm -rf ./dist && ./node_modules/.bin/tsc",
"test": "./node_modules/.bin/mocha test"
},
"private": true,
"dependencies": {
"joi": "11.4.0"
},
"devDependencies": {
"mocha": "^5.2.0",
"express": "^4.16.4",
"@types/express": "^4.16.1",
"@types/joi": "^14.3.0",
"@types/mocha": "^5.2.5",
"typescript": "^3.2.4"
}
}
我的文件夹结构是这样的:
- dist
- src
- http
- security
- test
AuthenticatedRequest.ts
我在以下位置创建了一个新的 TypeScript 文件src/http
:
import {Request} from "express";
import {UserReference} from "../security/UserReference";
export interface AuthenticatedRequest extends Request {
user: UserReference
}
src/security
包含一个UserReference.ts
:
import {Claim} from "./Claim";
export interface UserReference {
claims: Claim[];
}
和一个Claim.ts
:
import {IClaim} from "./IClaim";
export class Claim implements IClaim {
type: string;
value: string;
constructor(type: string, value: string) {
this.type = type;
this.value = value;
}
}
IClaim.ts
看起来像这样:
export interface IClaim {
type: string,
value: string
}
在test
中,我创建了AuthenticatedRequestTests.js
(纯 ES6,这里没有 TypeScript 来验证 ES6 的代码完成和使用):
'use strict';
const assert = require('assert');
const Claim = require("../dist/security/Claim").Claim;
describe('req', () => {
it('should ', done => {
/** @type {AuthenticatedRequest} */
const req = {};
req.user = { claims: [new Claim('tenantId', '123')] };
assert.equal(req.user.claims[ 0 ].type, 'tenantId');
assert.equal(req.user.claims[ 0 ].value, '123');
return done();
});
});
现在我有几个问题:
- 这是解决这个问题的预期 TypeScript 方法吗?
- 是否可以只使用
require("../dist/security/Claim");
而不是require("../dist/security/Claim").Claim;
? - 而不是使用这个
jsdoc
语句/** @type {AuthenticatedRequest} */
,我想使用/** @type {myLib.http.AuthenticatedRequest} */
我还创建了一个用于集成的本地测试项目,并通过npm link
.
但不是使用
const Claim = require("@scope/my-lib/security/Claim").Claim;
我必须使用
const Claim = require("@scope/my-lib/dist/security/Claim").Claim;
我怎样才能摆脱dist
这里的文件夹名称?
另外,使用集成测试项目中的jsdoc
注释AuthenticatedRequest
,我得到找不到类型的错误:
解决方案
package.json
应该有一个名为
types
(或typings
)的字段告诉您的库使用者您的项目的类型定义在哪里。如果它们是由 TypeScript 生成并保存到dist/index.d.ts
,那么这就是应该使用的路径。"types": "./dist/index.d.ts"
应该有一个名为的字段,
files
其中包含将交付给最终用户的文件/目录数组。
运行测试
这是解决这个问题的预期 TypeScript 方法吗?
如果您使用 TypeScript 来开发您的库,那么没有理由不使用 TypeScript 进行测试。那里有兼容 TypeScript 的测试运行器(
ts-jest
曾经很流行,现在 Jest 能够开箱即用地理解 TypeScript)。是否可以只使用
require("../dist/security/Claim");
而不是require("../dist/security/Claim").Claim;
?使用 TypeScript,可以使用几种语法。您可以
Claim
使用默认导出导出并执行以下操作:import Claim from "../dist/security/Claim";
或者:
const Claim = require("../dist/security/Claim");
/** @type {AuthenticatedRequest} */
我不想使用这个 jsdoc 语句,而是使用/** @type {myLib.http.AuthenticatedRequest} */
.您将需要一个导入类型。它们看起来像这样:
/** * @type {import('path/to/AuthenticatedRequest')} */ const req {}
路径可以是相对的或绝对的。如果您想将本地代码库视为从 npm 安装,您可以
package.json
在测试目录中创建另一个文件并使用相对路径来解析库模块。"dependencies": { "my-library": "../path/to/the/root" }
另外,在集成测试项目中使用 jsdoc 注释
AuthenticatedRequest
,我得到找不到类型的错误:这也可以通过导入类型来解决。除非类型不在全局范围内,否则您需要先导入它才能使用它。改为使用
import('path/to/AuthenticatedRequest')
。
有几件事正在发生。如果您可以创建一个公共存储库来展示您的问题,我相信我们会更容易帮助您解决这些问题。
推荐阅读
- r - 跨列使用 gsub
- python - 从文本 2 视觉转换决策树
- php - 在 SQLSRV 中添加 temptable 并查询它时没有返回结果
- javascript - 需要使用 js 限制可接受的输入框值(和文本长度)
- amazon-rekognition - 如何使用 amazon rekognition 存储图像的个人信息
- django - 如何强制 Django 使用“JOIN VALUES”
- python-3.x - 通过 Flask-Bootstrap 将 Flask WTForms 验证传递给 Bootstrap Alerts
- .net - 如何使用 .NET Standard 目标框架和 CMake 生成 Visual Studio 项目
- python - 如何有条件地仅映射列的空行?
- android - VS 2017中的Cordova在调试时清空android平台文件夹