diff options
Diffstat (limited to 'deps/npm/doc/api/run-script.md')
| -rw-r--r-- | deps/npm/doc/api/run-script.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/deps/npm/doc/api/run-script.md b/deps/npm/doc/api/run-script.md new file mode 100644 index 0000000000..f15900ecbc --- /dev/null +++ b/deps/npm/doc/api/run-script.md @@ -0,0 +1,27 @@ +npm-run-script(3) -- Run arbitrary package scripts +================================================== + +## SYNOPSIS + + npm.commands.run-script(args, callback) + +## DESCRIPTION + +This runs an arbitrary command from a package's "scripts" object. + +It is used by the test, start, restart, and stop commands, but can be +called directly, as well. + +The 'args' parameter is an array of strings. Behavior depends on the number +of elements. If there is only one element, npm assumes that the element +represents a command to be run on the local repository. If there is more than +one element, then the first is assumed to be the package and the second is +assumed to be the command to run. All other elements are ignored. + +## SEE ALSO + +* npm-scripts(1) +* npm-test(3) +* npm-start(3) +* npm-restart(3) +* npm-stop(3) |