Node.js modules are a type of package that can be published to npm.
package.json
filepackage.json
filepackage.json
file, on the command line, in the root directory of your Node.js module, run npm init
:npm init [email protected]
npm init
name
and version
), as well as the main
field:name
: The name of your module.version
: The initial module version. We recommend following semantic versioning guidelines and starting with 1.0.0
.For more information on package.json
files, see "Creating a package.json file".
In the file, add a function as a property of the exports
object. This will make the function available to other code:
exports.printMsg = function() { console.log("This is a message from the demo package"); }
Publish your package to npm:
npm publish
.npm publish --access public
On the command line, create a new test directory outside of your project directory.
mkdir test-directory
Switch to the new directory:
cd /path/to/test-directory
In the test directory, install your module:
npm install <your-module-name>
In the test directory, create a test.js
file which requires your module and calls your module as a method.
On the command line, run node test.js
. The message sent to the console.log should appear.
© npm, Inc. and Contributors
Licensed under the npm License.
npm is a trademark of npm, Inc.
https://docs.npmjs.com/creating-node-js-modules