Skip to content

Commit

Permalink
doc: fix documentation of process.argv
Browse files Browse the repository at this point in the history
The current documentation states that if run something like
`node app.js` then in our process.argv array first elements is `node`,
but actually it's `process.execPath` not `node`
as documentation currently suggests.

Fixes: #7434
PR-URL: #7449
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
tarungarg546 authored and Fishrock123 committed Jul 5, 2016
1 parent c132e9c commit 63d361b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -450,10 +450,11 @@ console.log(`This processor architecture is ${process.arch}`);
added: v0.1.27
-->

The `process.argv` property returns a array containing the command line
The `process.argv` property returns an array containing the command line
arguments passed when the Node.js process was launched. The first element will
be 'node', the second element will be the name of the JavaScript file. The
remaining elements will be any additional command line arguments.
be [`process.execPath`]. The second element will be the path to the
JavaScript file being executed. The remaining elements will be any additional
command line arguments.

For example, assuming the following script for `process-args.js`:

Expand All @@ -473,7 +474,7 @@ $ node process-2.js one two=three four
Would generate the output:

```text
0: node
0: /usr/local/bin/node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
Expand Down Expand Up @@ -1663,6 +1664,7 @@ cases:
[`process.argv`]: #process_process_argv
[`process.exit()`]: #process_process_exit_code
[`process.kill()`]: #process_process_kill_pid_signal
[`process.execPath`]: #process_process_execPath
[`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
[`require.main`]: modules.html#modules_accessing_the_main_module
[`setTimeout(fn, 0)`]: timers.html#timers_settimeout_callback_delay_arg
Expand Down

0 comments on commit 63d361b

Please sign in to comment.