93 lines
1.8 KiB
Groff
93 lines
1.8 KiB
Groff
|
.TH "NPM\-STOP" "1" "February 2022" "" ""
|
||
|
|
.SH "NAME"
|
||
|
|
\fBnpm-stop\fR \- Stop a package
|
||
|
|
.SS Synopsis
|
||
|
|
.P
|
||
|
|
.RS 2
|
||
|
|
.nf
|
||
|
|
npm stop [\-\- <args>]
|
||
|
|
.fi
|
||
|
|
.RE
|
||
|
|
.SS Description
|
||
|
|
.P
|
||
|
|
This runs a predefined command specified in the "stop" property of a
|
||
|
|
package's "scripts" object\.
|
||
|
|
.P
|
||
|
|
Unlike with npm help start, there is no default script
|
||
|
|
that will run if the \fB"stop"\fP property is not defined\.
|
||
|
|
.SS Example
|
||
|
|
.P
|
||
|
|
.RS 2
|
||
|
|
.nf
|
||
|
|
{
|
||
|
|
"scripts": {
|
||
|
|
"stop": "node bar\.js"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.RE
|
||
|
|
.P
|
||
|
|
.RS 2
|
||
|
|
.nf
|
||
|
|
npm stop
|
||
|
|
|
||
|
|
> npm@x\.x\.x stop
|
||
|
|
> node bar\.js
|
||
|
|
|
||
|
|
(bar\.js output would be here)
|
||
|
|
|
||
|
|
.fi
|
||
|
|
.RE
|
||
|
|
.SS Configuration
|
||
|
|
<!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
|
||
|
|
<!\-\- automatically generated, do not edit manually \-\->
|
||
|
|
<!\-\- see lib/utils/config/definitions\.js \-\->
|
||
|
|
.SS \fBignore\-scripts\fP
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 2
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 2
|
||
|
|
Type: Boolean
|
||
|
|
|
||
|
|
.RE
|
||
|
|
.P
|
||
|
|
If true, npm does not run scripts specified in package\.json files\.
|
||
|
|
.P
|
||
|
|
Note that commands explicitly intended to run a particular script, such as
|
||
|
|
\fBnpm start\fP, \fBnpm stop\fP, \fBnpm restart\fP, \fBnpm test\fP, and \fBnpm run\-script\fP
|
||
|
|
will still run their intended script if \fBignore\-scripts\fP is set, but they
|
||
|
|
will \fInot\fR run any pre\- or post\-scripts\.
|
||
|
|
<!\-\- automatically generated, do not edit manually \-\->
|
||
|
|
<!\-\- see lib/utils/config/definitions\.js \-\->
|
||
|
|
|
||
|
|
.SS \fBscript\-shell\fP
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 2
|
||
|
|
Default: '/bin/sh' on POSIX systems, 'cmd\.exe' on Windows
|
||
|
|
.IP \(bu 2
|
||
|
|
Type: null or String
|
||
|
|
|
||
|
|
.RE
|
||
|
|
.P
|
||
|
|
The shell to use for scripts run with the \fBnpm exec\fP, \fBnpm run\fP and \fBnpm
|
||
|
|
init <pkg>\fP commands\.
|
||
|
|
<!\-\- automatically generated, do not edit manually \-\->
|
||
|
|
<!\-\- see lib/utils/config/definitions\.js \-\->
|
||
|
|
|
||
|
|
<!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
|
||
|
|
|
||
|
|
.SS See Also
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 2
|
||
|
|
npm help run\-script
|
||
|
|
.IP \(bu 2
|
||
|
|
npm help scripts
|
||
|
|
.IP \(bu 2
|
||
|
|
npm help test
|
||
|
|
.IP \(bu 2
|
||
|
|
npm help start
|
||
|
|
.IP \(bu 2
|
||
|
|
npm help restart
|
||
|
|
|
||
|
|
.RE
|