Man1 - npm-stop.1

Table of Contents

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

<!– AUTOGENERATED CONFIG DESCRIPTIONS START –> <!– automatically generated, do not edit manually –> <!– see lib/utils/config/definitions.js –>

ignore-scripts

  • Default: false
  • 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. <!– automatically generated, do not edit manually –> <!– see lib/utils/config/definitions.js –>

script-shell

  • Default: ’/bin/sh’ on POSIX systems, ’cmd.exe’ on Windows
  • Type: null or String

The shell to use for scripts run with the npm exec, npm run and npm init <pkg> commands. <!– automatically generated, do not edit manually –> <!– see lib/utils/config/definitions.js –>

<!– AUTOGENERATED CONFIG DESCRIPTIONS END –>

See Also

  • npm help run-script
  • npm help scripts
  • npm help test
  • npm help start
  • npm help restart

Author: dt

Created: 2022-02-22 Tue 16:13