diff options
author | doug.wade <doug.wade@redfin.com> | 2016-05-04 16:35:14 -0700 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2016-05-27 09:28:48 -0700 |
commit | e916218ba5fd5a0e9cf104ecd3cd5e9db1f325fc (patch) | |
tree | aafeb8ab6cf7282a0221c6cb18d5a5d9498607fb /doc | |
parent | 6306b10c483e141a4e70b830ccc4072870474ab0 (diff) | |
download | android-node-v8-e916218ba5fd5a0e9cf104ecd3cd5e9db1f325fc.tar.gz android-node-v8-e916218ba5fd5a0e9cf104ecd3cd5e9db1f325fc.tar.bz2 android-node-v8-e916218ba5fd5a0e9cf104ecd3cd5e9db1f325fc.zip |
doc: update process.hrtime docs to include optional parameter
Adds more explicit documentation for the single optional parameter
to process.hrtime to the process docs.
PR-URL: https://github.com/nodejs/node/pull/6585
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/process.md | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/api/process.md b/doc/api/process.md index 693a6b909a..cb53dc3f5b 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -798,7 +798,7 @@ added: v0.1.13 * `code` {Integer} The exit code. Defaults to `0`. The `process.exit()` method instructs Node.js to terminate the process as -quickly as possible with the specified exit `code`. If the `code` is omitted, +quickly as possible with the specified exit `code`. If the `code` is omitted, exit uses either the 'success' code `0` or the value of `process.exitCode` if specified. @@ -811,7 +811,7 @@ process.exit(1); The shell that executed Node.js should see the exit code as `1`. It is important to note that calling `process.exit()` will force the process to -exit as quickly as possible *even if there are still asynchronous operations +exit as quickly as possible *even if there are still asynchronous operations pending* that have not yet completed fully, *including* I/O operations to `process.stdout` and `process.stderr`. @@ -820,8 +820,8 @@ explicitly. The Node.js process will exit on it's own *if there is no additional work pending* in the event loop. The `process.exitCode` property can be set to tell the process which exit code to use when the process exits gracefully. -For instance, the following example illustrates a *misuse* of the -`process.exit()` method that could lead to data printed to stdout being +For instance, the following example illustrates a *misuse* of the +`process.exit()` method that could lead to data printed to stdout being truncated and lost: ```js @@ -863,7 +863,7 @@ A number which will be the process exit code, when the process either exits gracefully, or is exited via [`process.exit()`][] without specifying a code. -Specifying a code to [`process.exit(code)`][`process.exit()`] will override any +Specifying a code to [`process.exit(code)`][`process.exit()`] will override any previous setting of `process.exitCode`. @@ -947,15 +947,18 @@ if (process.getuid) { } ``` -## process.hrtime() +## process.hrtime([time]) <!-- YAML added: v0.7.6 --> Returns the current high-resolution real time in a `[seconds, nanoseconds]` -tuple Array. It is relative to an arbitrary time in the past. It is not -related to the time of day and therefore not subject to clock drift. The -primary use is for measuring performance between intervals. +tuple Array. `time` is an optional parameter that must be the result of a +previous `process.hrtime()` call (and therefore, a real time in a +`[seconds, nanoseconds]` tuple Array containing a previous time) to diff with +the current time. These times are relative to an arbitrary time in the past, +and not related to the time of day and therefore not subject to clock drift. +The primary use is for measuring performance between intervals. You may pass in the result of a previous call to `process.hrtime()` to get a diff reading, useful for benchmarks and measuring intervals: @@ -973,6 +976,9 @@ setTimeout(() => { }, 1000); ``` +Constructing an array by some method other than calling `process.hrtime()` and +passing the result to process.hrtime() will result in undefined behavior. + ## process.initgroups(user, extra_group) <!-- YAML |