npm-stop.1 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. .TH "NPM\-STOP" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-stop\fR \- Stop a package
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm stop [\-\- <args>]
  9. .fi
  10. .RE
  11. .SS Description
  12. .P
  13. This runs a predefined command specified in the "stop" property of a
  14. package's "scripts" object\.
  15. .P
  16. Unlike with npm help start, there is no default script
  17. that will run if the \fB"stop"\fP property is not defined\.
  18. .SS Example
  19. .P
  20. .RS 2
  21. .nf
  22. {
  23. "scripts": {
  24. "stop": "node bar\.js"
  25. }
  26. }
  27. .fi
  28. .RE
  29. .P
  30. .RS 2
  31. .nf
  32. npm stop
  33. > npm@x\.x\.x stop
  34. > node bar\.js
  35. (bar\.js output would be here)
  36. .fi
  37. .RE
  38. .SS Configuration
  39. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  40. <!\-\- automatically generated, do not edit manually \-\->
  41. <!\-\- see lib/utils/config/definitions\.js \-\->
  42. .SS \fBignore\-scripts\fP
  43. .RS 0
  44. .IP \(bu 2
  45. Default: false
  46. .IP \(bu 2
  47. Type: Boolean
  48. .RE
  49. .P
  50. If true, npm does not run scripts specified in package\.json files\.
  51. .P
  52. Note that commands explicitly intended to run a particular script, such as
  53. \fBnpm start\fP, \fBnpm stop\fP, \fBnpm restart\fP, \fBnpm test\fP, and \fBnpm run\-script\fP
  54. will still run their intended script if \fBignore\-scripts\fP is set, but they
  55. will \fInot\fR run any pre\- or post\-scripts\.
  56. <!\-\- automatically generated, do not edit manually \-\->
  57. <!\-\- see lib/utils/config/definitions\.js \-\->
  58. .SS \fBscript\-shell\fP
  59. .RS 0
  60. .IP \(bu 2
  61. Default: '/bin/sh' on POSIX systems, 'cmd\.exe' on Windows
  62. .IP \(bu 2
  63. Type: null or String
  64. .RE
  65. .P
  66. The shell to use for scripts run with the \fBnpm exec\fP, \fBnpm run\fP and \fBnpm
  67. init <pkg>\fP commands\.
  68. <!\-\- automatically generated, do not edit manually \-\->
  69. <!\-\- see lib/utils/config/definitions\.js \-\->
  70. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  71. .SS See Also
  72. .RS 0
  73. .IP \(bu 2
  74. npm help run\-script
  75. .IP \(bu 2
  76. npm help scripts
  77. .IP \(bu 2
  78. npm help test
  79. .IP \(bu 2
  80. npm help start
  81. .IP \(bu 2
  82. npm help restart
  83. .RE