diff options
author | Yuta Hiroto <git@about-hiroppy.com> | 2018-03-04 22:46:49 +0900 |
---|---|---|
committer | Leko <leko.noor@gmail.com> | 2018-03-06 00:46:30 +0900 |
commit | 35c7238bb793ee6c6aa9f5f4f3577e94ea2b9837 (patch) | |
tree | ed7dd64b71ba39d8e7cfd015f5cdc3ce2fb50391 /doc/api | |
parent | 3ed363cb36a9fb686956c0b8b2953ff08a6f0ee8 (diff) | |
download | android-node-v8-35c7238bb793ee6c6aa9f5f4f3577e94ea2b9837.tar.gz android-node-v8-35c7238bb793ee6c6aa9f5f4f3577e94ea2b9837.tar.bz2 android-node-v8-35c7238bb793ee6c6aa9f5f4f3577e94ea2b9837.zip |
doc: replace to Node.js
PR-URL: https://github.com/nodejs/node/pull/19056
Reviewed-By: Matheus Marchini <matheus@sthima.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/cli.md | 4 | ||||
-rw-r--r-- | doc/api/deprecations.md | 2 | ||||
-rw-r--r-- | doc/api/documentation.md | 3 | ||||
-rw-r--r-- | doc/api/domain.md | 2 | ||||
-rw-r--r-- | doc/api/esm.md | 4 | ||||
-rw-r--r-- | doc/api/fs.md | 5 | ||||
-rw-r--r-- | doc/api/n-api.md | 2 | ||||
-rw-r--r-- | doc/api/tracing.md | 9 | ||||
-rw-r--r-- | doc/api/zlib.md | 2 |
9 files changed, 18 insertions, 15 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md index 9bc997a98a..2a1474f33f 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -452,8 +452,8 @@ added: v8.0.0 A space-separated list of command line options. `options...` are interpreted as if they had been specified on the command line before the actual command line -(so they can be overridden). Node will exit with an error if an option that is -not allowed in the environment is used, such as `-p` or a script file. +(so they can be overridden). Node.js will exit with an error if an option +that is not allowed in the environment is used, such as `-p` or a script file. Node options that are allowed are: - `--enable-fips` diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 8b501854f1..097fdfd079 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -610,7 +610,7 @@ a V8-inspector based CLI debugger available through `node inspect`. Type: End-of-Life -DebugContext has been removed in V8 and is not available in Node 10+. +DebugContext has been removed in V8 and is not available in Node.js 10+. DebugContext was an experimental API. diff --git a/doc/api/documentation.md b/doc/api/documentation.md index a864771f44..33da3a45e7 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -80,7 +80,8 @@ wish to do programmatic things with the documentation. ## Syscalls and man pages System calls like open(2) and read(2) define the interface between user programs -and the underlying operating system. Node functions which simply wrap a syscall, +and the underlying operating system. Node.js functions +which simply wrap a syscall, like [`fs.open()`][], will document that. The docs link to the corresponding man pages (short for manual pages) which describe how the syscalls work. diff --git a/doc/api/domain.md b/doc/api/domain.md index a9ca7f2d27..16fe3b6784 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -443,7 +443,7 @@ than crashing the program. ## Domains and Promises -As of Node 8.0.0, the handlers of Promises are run inside the domain in +As of Node.js 8.0.0, the handlers of Promises are run inside the domain in which the call to `.then` or `.catch` itself was made: ```js diff --git a/doc/api/esm.md b/doc/api/esm.md index adde6a199f..0db3db1d29 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -106,7 +106,7 @@ fs.readFile('./foo.txt', (err, body) => { <!-- type=misc --> To customize the default module resolution, loader hooks can optionally be -provided via a `--loader ./loader-name.mjs` argument to Node. +provided via a `--loader ./loader-name.mjs` argument to Node.js. When hooks are used they only apply to ES module loading and not to any CommonJS modules loaded. @@ -150,7 +150,7 @@ module. This can be one of the following: | `"dynamic"` | Use a [dynamic instantiate hook][] | For example, a dummy loader to load JavaScript restricted to browser resolution -rules with only JS file extension and Node builtin modules support could +rules with only JS file extension and Node.js builtin modules support could be written: ```js diff --git a/doc/api/fs.md b/doc/api/fs.md index f33bbe4785..a864503dbd 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -600,7 +600,7 @@ The times in the stat object have the following semantics: set to an earlier value than the current `birthtime` using the utimes(2) system call. -Prior to Node v0.12, the `ctime` held the `birthtime` on Windows +Prior to Node.js v0.12, the `ctime` held the `birthtime` on Windows systems. Note that as of v0.12, `ctime` is not "creation time", and on Unix systems, it never was. @@ -657,7 +657,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/6534 description: The constants like `fs.R_OK`, etc which were present directly on `fs` were moved into `fs.constants` as a soft deprecation. - Thus for Node `< v6.3.0` use `fs` to access those constants, or + Thus for Node.js `< v6.3.0` use `fs` + to access those constants, or do something like `(fs.constants || fs).R_OK` to work with all versions. --> diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 50f1f59512..12b37372ba 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -3489,7 +3489,7 @@ napi_status napi_get_node_version(napi_env env, ``` - `[in] env`: The environment that the API is invoked under. -- `[out] version`: A pointer to version information for Node itself. +- `[out] version`: A pointer to version information for Node.js itself. Returns `napi_ok` if the API succeeded. diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 4e161faf9c..ef58eb72ba 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -3,7 +3,7 @@ <!--introduced_in=v7.7.0--> Trace Event provides a mechanism to centralize tracing information generated by -V8, Node core, and userspace code. +V8, Node.js core, and userspace code. Tracing can be enabled by passing the `--trace-events-enabled` flag when starting a Node.js application. @@ -42,8 +42,9 @@ string that supports `${rotation}` and `${pid}`. For example: node --trace-events-enabled --trace-event-file-pattern '${pid}-${rotation}.log' server.js ``` -Starting with Node 10.0.0, the tracing system uses the same time source as the -one used by `process.hrtime()` however the trace-event timestamps are expressed -in microseconds, unlike `process.hrtime()` which returns nanoseconds. +Starting with Node.js 10.0.0, the tracing system uses the same time source +as the one used by `process.hrtime()` +however the trace-event timestamps are expressed in microseconds, +unlike `process.hrtime()` which returns nanoseconds. [Performance API]: perf_hooks.html diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 5c02c3a409..41b7ed4987 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -156,7 +156,7 @@ decompressed result is valid. <!--type=misc--> -From `zlib/zconf.h`, modified to node.js's usage: +From `zlib/zconf.h`, modified to Node.js's usage: The memory requirements for deflate are (in bytes): |