Section 3: library functions
npm — node package manager Synopsis var npm = require("npm") npm.load([configObject,] function (er, npm) { // use the npm object, now that it’s loaded. npm.config.set(key, val) val = npm.config.get(key) console.log("prefix = %s", npm.prefix) npm.commands.install(["package"], cb) }) Version 1.3.6 Description This is the API documentation for npm. To find documentation of the command line npm help…
npm-whoami — Display npm username Synopsis npm.commands.whoami(args, callback) Description Print the username config to standard output. ‘args’ is never used and callback is never called with data. ‘args’ must be present or things will break. This function is not useful programmatically
npm-view — View registry info Synopsis npm.commands.view(args, [silent,] callback) Description This command shows data about a package and prints it to the stream referenced by the outfd config, which defaults to stdout. The "args" parameter is an ordered list that closely resembles the command-line usage. The elements should be ordered such that the first element…
npm-version — Bump a package version Synopsis npm.commands.version(newversion, callback) Description Run this in a package directory to bump the version and write the new data back to the package.json file. If run in a git repo, it will also create a version commit and tag, and fail if the repo is not clean. Like all…
npm-update — Update a package Synopsis npm.commands.update(packages, callback) Updates a package, upgrading it to the latest version. It also installs any missing packages. The ‘packages’ argument is an array of packages to update. The ‘callback’ parameter will be called when done or when an error occurs.
npm-unpublish — Remove a package from the registry Synopsis npm.commands.unpublish(package, callback) Description This removes a package version from the registry, deleting its entry and removing the tarball. The package parameter must be defined. Only the first element in the package parameter is used. If there is no first element, then npm assumes that the package…
npm-uninstall — uninstall a package programmatically Synopsis npm.commands.uninstall(packages, callback) Description This acts much the same ways as uninstalling on the command-line. The ‘packages’ parameter is an array of strings. Each element in the array is the name of a package to be uninstalled. Finally, ‘callback’ is a function that will be called when all packages…
npm-test — Test a package Synopsis npm.commands.test(packages, callback) Description This runs a package’s "test" script, if one was provided. To run tests as a condition of installation, set the npat config to true. npm can run tests on multiple packages. Just specify multiple packages in the packages parameter.
npm-tag — Tag a published version Synopsis npm.commands.tag(package [at] version, tag, callback) Description Tags the specified version of the package with the specified tag, or the –tag config if not specified. The ‘package [at] version’ is an array of strings, but only the first two elements are currently used. The first element must be in…
npm-submodule — Add a package as a git submodule Synopsis npm.commands.submodule(packages, callback) Description For each package specified, npm will check if it has a git repository url in its package.json description then add it as a git submodule at node_modules/<pkg name>. This is a convenience only. From then on, it’s up to you to manage…
npm-stop — Stop a package Synopsis npm.commands.stop(packages, callback) Description This runs a package’s "stop" script, if one was provided. npm can run stop on multiple packages. Just specify multiple packages in the packages parameter.
npm-start — Start a package Synopsis npm.commands.start(packages, callback) Description This runs a package’s "start" script, if one was provided. npm can run tests on multiple packages. Just specify multiple packages in the packages parameter.
npm-shrinkwrap — programmatically generate package shrinkwrap file Synopsis npm.commands.shrinkwrap(args, [silent,] callback) Description This acts much the same ways as shrinkwrapping on the command-line. This command does not take any arguments, but ‘args’ must be defined. Beyond that, if any arguments are passed in, npm will politely warn that it does not take positional arguments. If…
npm-search — Search for packages Synopsis npm.commands.search(searchTerms, [silent,] [staleness,] callback) Description Search the registry for packages matching the search terms. The available parameters are: • searchTerms: Array of search terms. These terms are case-insensitive. • silent: If true, npm will not log anything to the console. • staleness: This is the threshold for stale packages….
npm-run-script — Run arbitrary package scripts Synopsis npm.commands.run-script(args, callback) Description This runs an arbitrary command from a package’s "scripts" object. It is used by the test, start, restart, and stop commands, but can be called directly, as well. The ‘args’ parameter is an array of strings. Behavior depends on the number of elements. If there…
npm-root — Display npm root Synopsis npm.commands.root(args, callback) Description Print the effective node_modules folder to standard out. ‘args’ is never used and callback is never called with data. ‘args’ must be present or things will break. This function is not useful programmatically.
npm-restart — Start a package Synopsis npm.commands.restart(packages, callback) Description This runs a package’s "restart" script, if one was provided. Otherwise it runs package’s "stop" script, if one was provided, and then the "start" script. If no version is specified, then it restarts the "active" version. npm can run tests on multiple packages. Just specify multiple…
npm-rebuild — Rebuild a package Synopsis npm.commands.rebuild([packages,] callback) Description This command runs the npm build command on each of the matched packages. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary. If no ‘packages’ parameter is specify, every package will be rebuilt….
npm-publish — Publish a package Synopsis npm.commands.publish([packages,] callback) Description Publishes a package to the registry so that it can be installed by name. Possible values in the ‘packages’ array are: • <folder>: A folder containing a package.json file • <tarball>: A url or file path to a gzipped tar archive containing a single folder with…
npm-prune — Remove extraneous packages Synopsis npm.commands.prune([packages,] callback) Description This command removes "extraneous" packages. The first parameter is optional, and it specifies packages to be removed. No packages are specified, then all packages will be checked. Extraneous packages are packages that are not listed on the parent package’s dependencies list.