Skip to content

Fix documentation of process.argv[0] #7449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tarungarg546 wants to merge 7 commits into from
Closed

Fix documentation of process.argv[0] #7449

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7e8ab82
Updated ReadMe for #7434
tarungarg546 Jun 27, 2016
1b1e5f6
docs:Modifying documentation for process.arv
tarungarg546 Jun 27, 2016
e620fa0
Changes as suggested by @mscdex & @cjihrig
tarungarg546 Jun 29, 2016
7b0096e
Changes as suggested by @mscdex & @cjihrig
tarungarg546 Jun 29, 2016
4cd4026
Changes as suggested by @mscdex & @cjihrig
tarungarg546 Jun 29, 2016
9afa7fd
Minor grammatical changes in doc for process api
tarungarg546 Jun 29, 2016
69456e4
Drop paranthesis around `process.execPath`
tarungarg546 Jul 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ added: v0.1.27

The `process.argv` property returns a 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
be [`process.execPath()`], the second element will be the name of the JavaScript file. The
Copy link
Contributor

@mscdex mscdex Jun 27, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we're in here, we may as well change "name of the JavaScript file" to something like "path to the JavaScript file."

Copy link
Contributor Author

@tarungarg546 tarungarg546 Jun 27, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fair enough?
What say @cjihrig

Copy link
Contributor

@cjihrig cjihrig Jun 28, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @mscdex. Also, this line should be wrapped at 80 characters.

Copy link
Member

@addaleax addaleax Jun 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. Is it a bug then that running a file named test.js using node test will lead to process.argv[1] === '/path/to/test', not /path/to/test.js?

Copy link
Member

@jasnell jasnell Jun 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm.. that's an interesting question... but I think that's ok. While there is the potential for conflicts because of the missing .js, it's not likely to have a serious impact. I guess that someone could come along and create a separate file named test after the app was started that would lead to issues but that seems like a relatively safe edge case.

Copy link
Contributor Author

@tarungarg546 tarungarg546 Jun 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done @cjihrig

remaining elements will be any additional command line arguments.

For example, assuming the following script for `process-args.js`:
Expand All @@ -473,7 +473,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 +1663,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