用 TypeScript 编写 npm 模块

2020-04-14 09:42:47

参考地址 用 TypeScript 编写 npm 模块

背景

自从开始使用 Node.js 已经一年多,写的代码越多,越是觉得自己提高的越慢。想来应该有没有将单一功能的代码封装在一个独立模块,而导致代码稍微多一点就维护困难的原因。

目标

最终目标

使用 TypeScript 编写一个 npm 模块,功能是通过 Express 中间件的形式对访问接口的用户进行操作鉴权。

目标分解

花了一下午的时间,想直接达到上面的最终目标,但是最后还是失败了。之前也经常会犯这样的错误,就是主观上不能接受自己能力差的事实,一次性目标定的太高,无法完成,心情低落,然后放弃。但我这次偏偏不放弃,而且以后也要吸取这次的教训。我这次把目标分解成一个个可以容易达到的小目标。

  • 用普通的 JavaScript 写一个最简单的 npm 模块;

  • 将刚才的 npm 模块加上一个 TypeScript 定义文件,使得 TypeScript 项目可以直接使用;

  • 使用 TypeScript 编写刚才的模块;

  • 使用 TypeScript 编写最终的功能模块;

用普通的 JavaScript 写一个最简单的 npm 模块

npm init 命令正常初始化一个项目,然后在 index.js 文件里编写如下内容。

exports.printMSG = function() {
  console.log('This message is from my npm module.');}

然后就可以直接发布在 npm 上了,前提是在 npm 上注册好了用户信息。

如果 npm 的仓库更换成立例如淘宝仓库等的其他仓库的话,需要先修改回 npm 官方仓库。

# npm config set registry https://registry.npmjs.org/

$ npm adduser # 添加 npm 用户信息$ npm config ls # 查看 npm 配置信息$ npm publish

就这样,一个全新的 npm 就发布上去了,就这样,一个小目标就先实现了。

原 npm 模块加上一个 TypeScript 定义文件

接着,再给这个 npm 模块加上一个 TypeScript 的说明文件,在项目根目录下建立一个 npm-js-demo.d.ts文件(任意名字都可以)。重要的是下一步,在 package.json 文件中加入以下一行,指明声明文件的位置。

"types": "npm-js-demo.d.ts"

然后修改版本号,再次发布。

$ npm version patch # 增加 patch 版本号,修改以后是 0.0.2$ npm publish

然后再建立一个新的项目,安装刚刚升级的 npm 模块做为依赖,即可以在项目中正常使用了。

import * as njd from 'node-js-demo';njd.printMSG();

增加辅助文件和内容

然后增加一些辅助的内容和文件,以便发布 npm 模块的时候屏蔽一些本地的设置或临时文件,

  • 增加 .gitignore 文件(如果没有 .npmignore 文件则默认使用该文件);

  • 增加 .npmignore 文件(可以覆盖 .gitignore 文件的设置);

  • 在 package.json 文件中增加 keywordsauthorrepository 等键值;

发布 npm 模块之前的本地化测试

为了防止发布的 npm 模块有问题而无法使用,应该首先在本地进行安装使用测试,具体流程如下,

在 npm-js-demo 项目下,运行命令。

npm install . -g

然后再其他测试项目中进行测试,

$ cd ../some-other-folder
$ npm install ../npm-js-demo

参考资料



  • 2019-04-01 23:20:58

    隐藏在图片中的密钥

    在客户端开发的时候,有时需要把密钥保存在本地。这时就会遇到密钥安全性的问题。要保证密钥安全性,无非就是混淆、隐藏、白盒等手段。本文以隐藏在图片中来阐述密钥的安全保存。

  • 2019-04-01 23:22:33

    验证数字签名

    应预先设置验证首选项。在打开 PDF 后显示包含签名的验证详细信息时,这有助于确保数字签名有效。有关详细信息,请参阅设置签名验证首选项。

  • 2019-04-01 23:23:27

    图像隐写之使用PHP隐藏图像中的文本

    隐写术是一门研究隐藏信息的科学艺术,通过隐写术,可以只让发送者和接收者知道隐藏的信息。 图像隐写术则是研究将数据隐藏在图像中,通过该技术可以防止无关用户发现这些隐藏的信息或数据。

  • 2019-04-08 16:01:57

    Window 设置pm2开机自启动服务

    下面用 pm2 来启动我们自己的服务程序 app.js, 然后告诉 pm2 开机后自动运行我 app.js 继续在管理员命令行下, cd 到 app.js 所在目录

  • 2019-04-10 17:25:21

    Joda-Time详解,最好用的java时间工具

    任何企业应用程序都需要处理时间问题。应用程序需要知道当前的时间点和下一个时间点,有时它们还必须计算这两个 时间点之间的路径。使用 JDK 完成这项任务将非常痛苦和繁琐。