Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

npm-stop (1)

Name

npm-stop - Stop a package Synopsis npm stop [-- <args>] Description This runs a predefined command specified in the "stop" property of a package's "scripts" object. Unlike with npm help start, there is no default script that will run if the "stop" property is not defined. Example { "scripts": { "stop": "node bar.js" } } npm stop > npm@x.x.x stop > node bar.js (bar.js output would be here) Configuration ignore-scripts o Default: false o Type: Boolean If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as npm start, npm stop, npm restart, npm test, and npm run-script will still run their intended script if ignore-scripts is set, but they will not run any pre- or post-scripts. script-shell o Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows o Type: null or String The shell to use for scripts run with the npm exec, npm run and npm init <pkg> commands. See Also o npm help run-script o npm help scripts o npm help test o npm help start o npm help restart

Synopsis

Please see following description for synopsis

Description

NPM-STOP(1)                                                        NPM-STOP(1)



NAME
       npm-stop - Stop a package

   Synopsis
         npm stop [-- <args>]

   Description
       This  runs  a  predefined command specified in the "stop" property of a
       package's "scripts" object.

       Unlike with npm help start, there is no default script that will run if
       the "stop" property is not defined.

   Example
         {
           "scripts": {
             "stop": "node bar.js"
           }
         }

         npm stop

         > npm@x.x.x stop
         > node bar.js

         (bar.js output would be here)


   Configuration
   ignore-scripts
       o Default: false

       o Type: Boolean


       If true, npm does not run scripts specified in package.json files.

       Note that commands explicitly intended to run a particular script, such
       as npm start, npm stop, npm restart, npm test, and npm run-script  will
       still run their intended script if ignore-scripts is set, but they will
       not run any pre- or post-scripts.

   script-shell
       o Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

       o Type: null or String


       The shell to use for scripts run with the npm exec,  npm  run  and  npm
       init <pkg> commands.

   See Also
       o npm help run-script

       o npm help scripts

       o npm help test

       o npm help start

       o npm help restart




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-18 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v18.1.0.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  April 2022                       NPM-STOP(1)