mirror of
https://github.com/nodejs/node.git
synced 2025-05-18 01:47:03 +00:00
db54b57042
PR-URL: https://github.com/nodejs/node/pull/34468 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# 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()
|
|
```
|