AlkantarClanX12
Current Path : /usr/lib/node_modules/npm/node_modules/npm-lifecycle/ |
Current File : //usr/lib/node_modules/npm/node_modules/npm-lifecycle/README.md |
# Note: pending imminent deprecation **This module will be deprecated once npm v7 is released. Please do not rely on it more than absolutely necessary.** The lifecycle script runner used in npm v7 is [@npmcli/run-script](http://npm.im/@npmcli/run-script). Please use that module moving forward. ----- # npm-lifecycle [`npm-lifecycle`](https://github.com/npm/npm-lifecycle) is a standalone library for executing packages' lifecycle scripts. It is extracted from npm itself and intended to be fully compatible with the way npm executes individual scripts. ## Install `$ npm install npm-lifecycle` ## Table of Contents * [Example](#example) * [Features](#features) * [Contributing](#contributing) * [API](#api) * [`lifecycle`](#lifecycle) ### Example ```javascript // idk yet ``` ### API #### <a name="lifecycle"></a> `> lifecycle(name, pkg, wd, [opts]) -> Promise` ##### Arguments * `opts.stdio` - the [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) passed to the child process. `[0, 1, 2]` by default. ##### Example ```javascript lifecycle() ```