时间:2021-05-26
比如前两天我需要使用hmac和sha1来做签名,就没有找到一个比较好用的模块,这时候就需要我们自己来实现相应的功能了。自己写完之后,再把它打包成一个模块分享给大家来用,即方便了其他人,又能让自己有点小小的成就感,实在是一件一举多得的好事情。接下来,我就为大家介绍一下如何封装一个NodeJS模块并把它分享给其他人。
NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模块管理软件,除 NodeJS 内置的核心模块外,其他模块的安装、卸载等管理操作都要通过 NPM 来进行,我们自己写的模块,就要发布到NPM上来供其他人使用。
接下来,我们做一个非常简单的模块 “hello”,这个模块的功能只有一个:提供一个参数 “name” ,它在控制台输出 “Hello name”。在开始之前,我们首先要把node和npm装好,安装方法在其官方网站都有介绍,这里就不再多说了。
首先,我们创建一个名为”hello”的目录,作为模块的主目录。进入该目录,开始我们的工作。
然后,写模块的核心代码,很简单,只有以下三行:
复制代码 代码如下:
exports.Hello = function ( name ) {
console.log( "Hello " + name );
}
把它保存为 hello.js。
NodeJS每个扩展模块中都有一个package.json文件,用来描述模块的一些基本属性,比如模块名称、作者、版本号等等。关于package.json写法的详细说明,可以使用 “npm help json” 命令来查看。
我们可以在模块主目录下执行 npm init 来生成一个最基本的package.json。按照命令的提示依次输入信息即可。以下是在 hello 目录下执行 npm init 并填入相关信息后的结果:
复制代码 代码如下:
$ npm init
Package name: (hello) //模块名字,npm init会自动取当前目录名作为默认名字,这里不需要改,直接确认即可
Description: A example for write a module //模块说明
Package version: (0.0.0) 0.0.1 //模块版本号,这个大家按自己习惯来定就可以
Project homepage: (none) //模块的主页,如果有的话可以填在这里,也可以不填
Project git repository: (none) //模块的git仓库,选填。npm的用户一般都使用github做为自己的git仓库
Author name: Elmer Zhang //模块作者名字
Author email: (none) freeboy6716@gmail.com //模块作者邮箱
Author url: (none) http://
简单三步,一个NPM用户注册成功。
最后回到 hello 根目录,执行一下npm publish,如果没有任何错误提示,那么就发布成功了。去 http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest Updates”一栏里了。
至此,一个NodeJS模块成功发布到NPM,以后就可以在任何能访问npm库的地方通过npm install来安装你的模块了。
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
本文实例讲述了nodejs判断文件、文件夹是否存在及删除的方法。分享给大家供大家参考,具体如下:判断文件、文件夹是否存在需要使用nodejs的fs模块引入var
本文实例讲述了nodejs基础之常用工具模块util用法。分享给大家供大家参考,具体如下:util是nodejs的核心模块,提供常用函数的集合,用户弥补核心ja
本文实例讲述了nodeJS模块简单用法。分享给大家供大家参考,具体如下:1.定义Student模块,Teacher模块functionadd(student){
本文实例讲述了nodejs模块xml2js解析xml过程中遇到的坑。分享给大家供大家参考,具体如下:在一个项目中,用到nodejs模块xml2js解析xml,x
本文实例讲述了nodejs制作小爬虫功能。分享给大家供大家参考,具体如下:1安装nodejs2安装需要模块npminstallrequestcheerio3新建