首页 > 编程语言 >npm学习(六)之如何创建 Node.js 模块

npm学习(六)之如何创建 Node.js 模块

时间:2023-11-28 12:48:21浏览次数:34  
标签:npm Node package 创建 js json 模块

 

 

如何创建 Node.js 模块

Node.js 模块是一种可以发布到 npm 的包。当你创建一个新模块时,创建 package.json 文件是第一步。

你可以使用 npm init 命令创建 package.json 文件。命令行中将会提示 package.json 字段中需要你输入的值。名称(name) 和 版本(version) 这两个字段是必填的。你还需要输入 入口文件字段(main) 字段,当然,可以使用默认值 index.js。这些步骤在npm学习(五)之使用package.json有详细的讲解。

如果你想为作者(author)字段添加信息,你可以使用以下格式(邮箱、网址都是选填的):Your Name <[email protected]> (http://example.com)

创建 package.json 文件之后,还需要创建模块的入口文件。如果使用默认值,文件名是 index.js

在此文件中,添加一个函数,作为 exports对象的一个属性。这样,require 此文件之后,这个函数在其他代码中就可以使用了。

exports.printMsg = function() {
  console.log("This is a message from the demo package");
}

试一试:

  1. 将你的包发布到 npm。
  2. 在你的项目外新建一个目录。
  3. 然后 cd 进入这个新目录。
  4. 执行 npm install <package> 命令。
  5. 创建一个 test.js 文件,require 这个包,并调用其中的方法。
  6. 执行 node test.js 命令。是否输出 console.log 中填写的信息?

标签:npm,Node,package,创建,js,json,模块
From: https://www.cnblogs.com/onesea/p/17861654.html

相关文章

  • npm学习(三)之如何安装本地包、更新本地安装的包、卸载本地安装的包
     如何安装本地包有两种方式用来安装npm包:本地安装和全局安装。至于选择哪种方式来安装,取决于我们如何使用这个包。如果你自己的模块依赖于某个包,并通过Node.js的 require 加载,那么你应该选择本地安装,这种方式也是 npminstall 命令的默认行为。如果你想将包作为一......
  • npm学习(四)之如何安装全局包、更新全局安装的包、卸载全局安装的包
      如何安装全局包有两种方式用来安装npm包:本地安装和全局安装。选用哪种方式来安装,取决于你如何使用这个包。如果你想将其作为一个命令行工具,那么你应该将其安装到全局。这种安装方式后可以让你在任何目录下使用这个包。比如grunt就应该以这种方式安装。如果您希......
  • npm学习(二)之如何防止权限错误
     如何防止权限错误如果您在尝试全局安装包时看到EACCES错误,请阅读本章。如果更改安装npm的目录,通常可以避免此错误。要做到这一点,要么使用版本管理器重新安装npm(推荐)或手动更改npm的默认目录。选项一:使用节点版本管理器重新安装这是避免权限问题的最佳方法,在安装节点版......
  • npm学习(一)之安装、更新以及管理npm版本
      安装npm安装前须知:npm是在Node中编写的,因此需要安装Node.js才能使用npm。可以通过Node.js网站安装npm,或者安装节点版本管理器NVM。如果只是想开始探索npm,使用Node.js安装方法是最快的。如果您是一名高级开发人员,准备投入工作并使用版本,请使用node版本管理器。如果你不......
  • npm学习(十三)之npm命令
      npm:查看npm所有命令自己写包可能用到的命令:npmadduser:注册npmlogin:登录npmwhami:查看当前用户名npminit:初始化包的信息npmpublish:发布包/更新包npmpublish--access=public:发布公共作用域包npmunpublishxxx(包名) --force:强制删除包npm......
  • npm学习(十六)之package-lock.json和package.json的作用
      转自:https://www.cnblogs.com/cangqinglang/p/8336754.htmlpackage-lock.json的作用就是锁定安装依赖时包的版本,并且需要上传到git,以保证其他人npminstall时安装的依赖能够保持一致 根据官方文档,这个package-lock.json是在`npminstall`时候生成的一份文件,用以记录......
  • npm学习(十四)之npm5踩过的坑!
     1.版本问题导致环境问题npm5之前我们第一次npminstall时是根据package.json来安装相关依赖的,但是它里面的版本不固定,因此默认会根据最高的版本来安装相关依赖,但是在npm5是根据package-lock.json来安装相关依赖的,但前提是没有在命令行中新安装依赖或者更改package.json,否则......
  • npm学习(十五)之理解npm、nvm、nodejs之间的关系
      nvmnvm:nodeJs版本管理工具,管理nodejs版本和npm版本,使用nvm安装nodejs时会将npm一起安装下来nodejsnodeJs: 一种高效的JavaScript运行环境npmnpm:是随同nodeJs一起安装的包管理工具,npm管理对应nodeJs的第三方插件  常见的使用场景有以下几种:  .允许用户从......
  • npm学习(十一)之package-lock.json
      package-lock.json描述对于npm修改node_modules树或package.json的任何操作,都会自动生成package-lock.json,它描述生成的确切树,以便后续安装能够生成相同的树,而不管中间依赖项更新如何。此文件拟提交至来源资料库,并可作以下用途:描述依赖关系树的单一表示形式,以确保队......
  • npm学习(十)之如何使用创建、发布、使用作用域包
      前言要求npm版本2或更高作用域用于将相关包分组在一起,并为npm模块创建一个名称空间(类似于域)。这里有更详细的解释。如果一个包的名称以@开头,那么它就是一个有作用域的包。范围是@和斜杠之间的所有内容。@scope/project-name每个npm用户都有自己的范围。@userna......