1# Note: pending imminent deprecation 2 3**This module will be deprecated once npm v7 is released. Please do not rely 4on it more than absolutely necessary.** 5 6The lifecycle script runner used in npm v7 is 7[@npmcli/run-script](http://npm.im/@npmcli/run-script). Please use that 8module moving forward. 9 10----- 11 12# npm-lifecycle 13 14[`npm-lifecycle`](https://github.com/npm/npm-lifecycle) is a standalone library for 15executing packages' lifecycle scripts. It is extracted from npm itself and 16intended to be fully compatible with the way npm executes individual scripts. 17 18## Install 19 20`$ npm install npm-lifecycle` 21 22## Table of Contents 23 24* [Example](#example) 25* [Features](#features) 26* [Contributing](#contributing) 27* [API](#api) 28 * [`lifecycle`](#lifecycle) 29 30### Example 31 32```javascript 33// idk yet 34``` 35 36### API 37 38#### <a name="lifecycle"></a> `> lifecycle(name, pkg, wd, [opts]) -> Promise` 39 40##### Arguments 41 42* `opts.stdio` - the [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) 43passed to the child process. `[0, 1, 2]` by default. 44 45##### Example 46 47```javascript 48lifecycle() 49``` 50