Skip to content

doc: add process api data types to documentation #9505

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
imatveev wants to merge 4 commits into from
Closed

doc: add process api data types to documentation #9505

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
08f08fb
doc: add process api data types to documentation
imatveev Nov 7, 2016
c2fee1c
doc: move to Return and Integer
Nov 8, 2016
98585f6
doc: removed redundant return
Nov 8, 2016
81ead0b
doc: add extra line for consistency
Nov 8, 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
Prev Previous commit
Next Next commit
doc: move to Return and Integer
  • Loading branch information
Ivan Matvieiev committed Nov 8, 2016
commit c2fee1cf95bcfbe253b8581d928441fd1087791e
34 changes: 17 additions & 17 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,9 +613,9 @@ added: v6.1.0

* `previousValue` {Object} A previous return value from calling
`process.cpuUsage()`
* return: {Object}
* `user` {Number}
* `system` {Number}
* Return: {Object}
* `user` {Integer}
* `system` {Integer}

The `process.cpuUsage()` method returns the user and system CPU time usage of
the current process, in an object with properties `user` and `system`, whose
Expand Down Expand Up @@ -643,7 +643,7 @@ console.log(process.cpuUsage(startUsage));
added: v0.1.8
-->

* return: {String}
* Return: {String}

The `process.cwd()` method returns the current working directory of the Node.js
process.
Expand Down Expand Up @@ -878,7 +878,7 @@ that started the Node.js process.

For example:

```sh
```js
'/usr/local/bin/node'
```

Expand Down Expand Up @@ -952,7 +952,7 @@ is safer than calling `process.exit()`.
added: v0.11.8
-->

* {Number}
* {Integer}

A number which will be the process exit code, when the process either
exits gracefully, or is exited via [`process.exit()`][] without specifying
Expand Down Expand Up @@ -984,7 +984,7 @@ or Android)
added: v2.0.0
-->

* return: {Object}
* Return: {Object}

The `process.geteuid()` method returns the numerical effective user identity of
the process. (See geteuid(2).)
Expand All @@ -1003,7 +1003,7 @@ Android)
added: v0.1.31
-->

* return: {Object}
* Return: {Object}

The `process.getgid()` method returns the numerical group identity of the
process. (See getgid(2).)
Expand All @@ -1023,7 +1023,7 @@ Android)
added: v0.9.4
-->

* return: {Array}
* Return: {Array}

The `process.getgroups()` method returns an array with the supplementary group
IDs. POSIX leaves it unspecified if the effective group ID is included but
Expand All @@ -1037,7 +1037,7 @@ Android)
added: v0.1.28
-->

* return: {Number}
* Return: {Integer}

The `process.getuid()` method returns the numeric user identity of the process.
(See getuid(2).)
Expand Down Expand Up @@ -1171,10 +1171,10 @@ is no entry script.
added: v0.1.16
-->

* return: {Object}
* `rss` {Number}
* `heapTotal` {Number}
* `heapUsed` {Number}
* Return: {Object}
* `rss` {Integer}
* `heapTotal` {Integer}
* `heapUsed` {Integer}

The `process.memoryUsage()` method returns an object describing the memory usage
of the Node.js process measured in bytes.
Expand Down Expand Up @@ -1295,7 +1295,7 @@ happening, just like a `while(true);` loop.
added: v0.1.15
-->

* {Number}
* {Integer}

The `process.pid` property returns the PID of the process.

Expand Down Expand Up @@ -1662,7 +1662,7 @@ console.log(
added: v0.5.0
-->

* return: {Number}
* Return: {Number}

The `process.uptime()` method returns the number of seconds the current Node.js
process has been running.
Expand All @@ -1685,7 +1685,7 @@ console.log(`Version: ${process.version}`);
added: v0.2.0
-->

* return: {Object}
* Return: {Object}
Copy link
Copy Markdown
Member

@lpinca lpinca Nov 8, 2016

Choose a reason for hiding this comment

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

I think "Return:" should be removed here.

Copy link
Copy Markdown
Contributor

@mscdex mscdex Nov 8, 2016

Choose a reason for hiding this comment

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

Agreed.


The `process.versions` property returns an object listing the version strings of
Node.js and its dependencies.
Expand Down