doc: remove redundant empty lines

PR-URL: https://github.com/nodejs/node/pull/20398
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Vse Mozhet Byt 2018-04-29 12:49:56 +03:00
parent 8809f8b40b
commit a3bd06a5e6
26 changed files with 3 additions and 106 deletions

View File

@ -217,7 +217,6 @@ Addon developers are recommended to use to keep compatibility between past and
future releases of V8 and Node.js. See the `nan` [examples][] for an
illustration of how it can be used.
## N-API
> Stability: 1 - Experimental
@ -307,7 +306,6 @@ built using `node-gyp`:
$ node-gyp configure build
```
### Function arguments
Addons will typically expose objects and functions that can be accessed from
@ -381,7 +379,6 @@ const addon = require('./build/Release/addon');
console.log('This should be eight:', addon.add(3, 5));
```
### Callbacks
It is common practice within Addons to pass JavaScript functions to a C++
@ -488,7 +485,6 @@ console.log(obj1.msg, obj2.msg);
// Prints: 'hello world'
```
### Function factory
Another common scenario is creating JavaScript functions that wrap C++
@ -546,7 +542,6 @@ console.log(fn());
// Prints: 'hello world'
```
### Wrapping C++ objects
It is also possible to wrap C++ objects/classes in a way that allows new
@ -916,7 +911,6 @@ console.log(obj2.plusOne());
// Prints: 23
```
### Passing wrapped objects around
In addition to wrapping and returning C++ objects, it is possible to pass

View File

@ -141,7 +141,6 @@ future. This is subject to change in the future if a comprehensive analysis is
performed to ensure an exception can follow the normal control flow without
unintentional side effects.
##### Printing in AsyncHooks callbacks
Because printing to the console is an asynchronous operation, `console.log()`
@ -257,7 +256,6 @@ the new resource to initialize and that caused `init` to call. This is different
from `async_hooks.executionAsyncId()` that only shows *when* a resource was
created, while `triggerAsyncId` shows *why* a resource was created.
The following is a simple demonstration of `triggerAsyncId`:
```js
@ -395,7 +393,6 @@ API the user's callback is placed in a `process.nextTick()`.
The graph only shows *when* a resource was created, not *why*, so to track
the *why* use `triggerAsyncId`.
##### before(asyncId)
* `asyncId` {number}
@ -413,7 +410,6 @@ asynchronous resources like a TCP server will typically call the `before`
callback multiple times, while other operations like `fs.open()` will call
it only once.
##### after(asyncId)
* `asyncId` {number}
@ -424,7 +420,6 @@ If an uncaught exception occurs during execution of the callback, then `after`
will run *after* the `'uncaughtException'` event is emitted or a `domain`'s
handler runs.
##### destroy(asyncId)
* `asyncId` {number}

View File

@ -456,7 +456,6 @@ ls.on('close', (code) => {
});
```
Example: A very elaborate way to run `ps ax | grep ssh`
```js
@ -494,7 +493,6 @@ grep.on('close', (code) => {
});
```
Example of checking for failed `spawn`:
```js

View File

@ -8,7 +8,6 @@ debugging, multiple ways to execute scripts, and other helpful runtime options.
To view this documentation as a manual page in a terminal, run `man node`.
## Synopsis
`node [options] [V8 options] [script.js | -e "script" | -] [--] [arguments]`
@ -21,7 +20,6 @@ Execute without arguments to start the [REPL][].
_For more info about `node debug`, please see the [debugger][] documentation._
## Options
### `-`
@ -33,7 +31,6 @@ Alias for stdin, analogous to the use of - in other command line utilities,
meaning that the script will be read from stdin, and the rest of the options
are passed to that script.
### `--`
<!-- YAML
added: v6.11.0
@ -43,7 +40,6 @@ Indicate the end of node options. Pass the rest of the arguments to the script.
If no script filename or eval/print script is supplied prior to this, then
the next argument will be used as a script filename.
### `--abort-on-uncaught-exception`
<!-- YAML
added: v0.10
@ -56,7 +52,6 @@ If this flag is passed, the behavior can still be set to not abort through
[`process.setUncaughtExceptionCaptureCallback()`][] (and through usage of the
`domain` module that uses it).
### `--enable-fips`
<!-- YAML
added: v6.0.0
@ -65,7 +60,6 @@ added: v6.0.0
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
`./configure --openssl-fips`)
### `--experimental-modules`
<!-- YAML
added: v8.5.0
@ -73,7 +67,6 @@ added: v8.5.0
Enable experimental ES module support and caching modules.
### `--experimental-repl-await`
<!-- YAML
added: v10.0.0
@ -81,7 +74,6 @@ added: v10.0.0
Enable experimental top-level `await` keyword support in REPL.
### `--experimental-vm-modules`
<!-- YAML
added: v9.6.0
@ -89,7 +81,6 @@ added: v9.6.0
Enable experimental ES Module support in the `vm` module.
### `--force-fips`
<!-- YAML
added: v6.0.0
@ -98,7 +89,6 @@ added: v6.0.0
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
(Same requirements as `--enable-fips`)
### `--icu-data-dir=file`
<!-- YAML
added: v0.11.15
@ -106,7 +96,6 @@ added: v0.11.15
Specify ICU data load path. (overrides `NODE_ICU_DATA`)
### `--inspect-brk[=[host:]port]`
<!-- YAML
added: v7.6.0
@ -115,7 +104,6 @@ added: v7.6.0
Activate inspector on host:port and break at start of user script.
Default host:port is 127.0.0.1:9229.
### `--inspect-port=[host:]port`
<!-- YAML
added: v7.6.0
@ -126,7 +114,6 @@ Useful when activating the inspector by sending the `SIGUSR1` signal.
Default host is 127.0.0.1.
### `--inspect[=[host:]port]`
<!-- YAML
added: v6.3.0
@ -138,7 +125,6 @@ V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug
and profile Node.js instances. The tools attach to Node.js instances via a
tcp port and communicate using the [Chrome DevTools Protocol][].
### `--napi-modules`
<!-- YAML
added: v7.10.0
@ -146,7 +132,6 @@ added: v7.10.0
This option is a no-op. It is kept for compatibility.
### `--no-deprecation`
<!-- YAML
added: v0.8.0
@ -154,7 +139,6 @@ added: v0.8.0
Silence deprecation warnings.
### `--no-force-async-hooks-checks`
<!-- YAML
added: v9.0.0
@ -163,7 +147,6 @@ added: v9.0.0
Disables runtime checks for `async_hooks`. These will still be enabled
dynamically when `async_hooks` is enabled.
### `--no-warnings`
<!-- YAML
added: v6.0.0
@ -171,7 +154,6 @@ added: v6.0.0
Silence all process warnings (including deprecations).
### `--openssl-config=file`
<!-- YAML
added: v6.9.0
@ -181,7 +163,6 @@ Load an OpenSSL configuration file on startup. Among other uses, this can be
used to enable FIPS-compliant crypto if Node.js is built with
`./configure --openssl-fips`.
### `--pending-deprecation`
<!-- YAML
added: v8.0.0
@ -196,7 +177,6 @@ unless either the `--pending-deprecation` command line flag, or the
are used to provide a kind of selective "early warning" mechanism that
developers may leverage to detect deprecated API usage.
### `--preserve-symlinks`
<!-- YAML
added: v6.3.0
@ -237,7 +217,6 @@ are linked from more than one location in the dependency tree (Node.js would
see those as two separate modules and would attempt to load the module multiple
times, causing an exception to be thrown).
### `--prof-process`
<!-- YAML
added: v5.2.0
@ -245,7 +224,6 @@ added: v5.2.0
Process V8 profiler output generated using the V8 option `--prof`.
### `--redirect-warnings=file`
<!-- YAML
added: v8.0.0
@ -256,7 +234,6 @@ file will be created if it does not exist, and will be appended to if it does.
If an error occurs while attempting to write the warning to the file, the
warning will be written to stderr instead.
### `--throw-deprecation`
<!-- YAML
added: v0.11.14
@ -264,7 +241,6 @@ added: v0.11.14
Throw errors for deprecations.
### `--tls-cipher-list=list`
<!-- YAML
added: v4.0.0
@ -273,7 +249,6 @@ added: v4.0.0
Specify an alternative default TLS cipher list. (Requires Node.js to be built
with crypto support. (Default))
### `--trace-deprecation`
<!-- YAML
added: v0.8.0
@ -281,7 +256,6 @@ added: v0.8.0
Print stack traces for deprecations.
### `--trace-event-categories`
<!-- YAML
added: v7.7.0
@ -290,7 +264,6 @@ added: v7.7.0
A comma separated list of categories that should be traced when trace event
tracing is enabled using `--trace-events-enabled`.
### `--trace-event-file-pattern`
<!-- YAML
added: v9.8.0
@ -299,7 +272,6 @@ added: v9.8.0
Template string specifying the filepath for the trace event data, it
supports `${rotation}` and `${pid}`.
### `--trace-events-enabled`
<!-- YAML
added: v7.7.0
@ -307,7 +279,6 @@ added: v7.7.0
Enables the collection of trace event tracing information.
### `--trace-sync-io`
<!-- YAML
added: v2.1.0
@ -316,7 +287,6 @@ added: v2.1.0
Prints a stack trace whenever synchronous I/O is detected after the first turn
of the event loop.
### `--trace-warnings`
<!-- YAML
added: v6.0.0
@ -324,7 +294,6 @@ added: v6.0.0
Print stack traces for process warnings (including deprecations).
### `--track-heap-objects`
<!-- YAML
added: v2.4.0
@ -332,7 +301,6 @@ added: v2.4.0
Track heap object allocations for heap snapshots.
### `--use-bundled-ca`, `--use-openssl-ca`
<!-- YAML
added: v6.11.0
@ -353,7 +321,6 @@ environment variables.
See `SSL_CERT_DIR` and `SSL_CERT_FILE`.
### `--v8-options`
<!-- YAML
added: v0.1.3
@ -366,7 +333,6 @@ underscores (`_`).
For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`.
### `--v8-pool-size=num`
<!-- YAML
added: v5.10.0
@ -380,7 +346,6 @@ on the number of online processors.
If the value provided is larger than V8's maximum, then the largest value
will be chosen.
### `--zero-fill-buffers`
<!-- YAML
added: v6.0.0
@ -389,7 +354,6 @@ added: v6.0.0
Automatically zero-fills all newly allocated [`Buffer`][] and [`SlowBuffer`][]
instances.
### `-c`, `--check`
<!-- YAML
added:
@ -403,7 +367,6 @@ changes:
Syntax check the script without executing.
### `-e`, `--eval "script"`
<!-- YAML
added: v0.5.2
@ -420,7 +383,6 @@ On Windows, using `cmd.exe` a single quote will not work correctly because it
only recognizes double `"` for quoting. In Powershell or Git bash, both `'`
and `"` are usable.
### `-h`, `--help`
<!-- YAML
added: v0.1.3
@ -429,7 +391,6 @@ added: v0.1.3
Print node command line options.
The output of this option is less detailed than this document.
### `-i`, `--interactive`
<!-- YAML
added: v0.7.7
@ -437,7 +398,6 @@ added: v0.7.7
Opens the REPL even if stdin does not appear to be a terminal.
### `-p`, `--print "script"`
<!-- YAML
added: v0.6.4
@ -449,7 +409,6 @@ changes:
Identical to `-e` but prints the result.
### `-r`, `--require module`
<!-- YAML
added: v1.6.0
@ -460,7 +419,6 @@ Preload the specified module at startup.
Follows `require()`'s module resolution
rules. `module` may be either a path to a file, or a node module name.
### `-v`, `--version`
<!-- YAML
added: v0.1.3
@ -477,7 +435,6 @@ added: v0.1.32
`','`-separated list of core modules that should print debug information.
### `NODE_DISABLE_COLORS=1`
<!-- YAML
added: v0.3.0
@ -485,7 +442,6 @@ added: v0.3.0
When set to `1` colors will not be used in the REPL.
### `NODE_EXTRA_CA_CERTS=file`
<!-- YAML
added: v7.3.0
@ -500,7 +456,6 @@ malformed, but any errors are otherwise ignored.
Note that neither the well known nor extra certificates are used when the `ca`
options property is explicitly specified for a TLS or HTTPS client or server.
### `NODE_ICU_DATA=file`
<!-- YAML
added: v0.11.15
@ -509,7 +464,6 @@ added: v0.11.15
Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small-icu support.
### `NODE_NO_WARNINGS=1`
<!-- YAML
added: v6.11.0
@ -517,7 +471,6 @@ added: v6.11.0
When set to `1`, process warnings are silenced.
### `NODE_OPTIONS=options...`
<!-- YAML
added: v8.0.0
@ -561,7 +514,6 @@ V8 options that are allowed are:
- `--perf-prof`
- `--stack-trace-limit`
### `NODE_PATH=path[:…]`
<!-- YAML
added: v0.1.32
@ -571,7 +523,6 @@ added: v0.1.32
On Windows, this is a `';'`-separated list instead.
### `NODE_PENDING_DEPRECATION=1`
<!-- YAML
added: v8.0.0
@ -586,7 +537,6 @@ unless either the `--pending-deprecation` command line flag, or the
are used to provide a kind of selective "early warning" mechanism that
developers may leverage to detect deprecated API usage.
### `NODE_PRESERVE_SYMLINKS=1`
<!-- YAML
added: v7.1.0
@ -595,7 +545,6 @@ added: v7.1.0
When set to `1`, instructs the module loader to preserve symbolic links when
resolving and caching modules.
### `NODE_REDIRECT_WARNINGS=file`
<!-- YAML
added: v8.0.0
@ -607,7 +556,6 @@ appended to if it does. If an error occurs while attempting to write the
warning to the file, the warning will be written to stderr instead. This is
equivalent to using the `--redirect-warnings=file` command-line flag.
### `NODE_REPL_HISTORY=file`
<!-- YAML
added: v3.0.0
@ -617,7 +565,6 @@ Path to the file used to store the persistent REPL history. The default path is
`~/.node_repl_history`, which is overridden by this variable. Setting the value
to an empty string (`''` or `' '`) disables persistent REPL history.
### `OPENSSL_CONF=file`
<!-- YAML
added: v6.11.0
@ -630,7 +577,6 @@ used to enable FIPS-compliant crypto if Node.js is built with `./configure
If the [`--openssl-config`][] command line option is used, the environment
variable is ignored.
### `SSL_CERT_DIR=dir`
<!-- YAML
added: v7.7.0
@ -643,7 +589,6 @@ Be aware that unless the child environment is explicitly set, this environment
variable will be inherited by any child processes, and if they use OpenSSL, it
may cause them to trust the same CAs as node.
### `SSL_CERT_FILE=file`
<!-- YAML
added: v7.7.0
@ -656,7 +601,6 @@ Be aware that unless the child environment is explicitly set, this environment
variable will be inherited by any child processes, and if they use OpenSSL, it
may cause them to trust the same CAs as node.
### `UV_THREADPOOL_SIZE=size`
Set the number of threads used in libuv's threadpool to `size` threads.

View File

@ -63,7 +63,6 @@ changes:
will now be ignored by default.
-->
<!--type=class-->
The `Console` class can be used to create a simple logger with configurable

View File

@ -2626,7 +2626,6 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
</tr>
</table>
[`Buffer`]: buffer.html
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size

View File

@ -464,7 +464,6 @@ A socket's address family's ANY address (IPv4 `'0.0.0.0'` or IPv6 `'::'`) can be
used to return control of the sockets default outgoing interface to the system
for future multicast packets.
### socket.setMulticastLoopback(flag)
<!-- YAML
added: v0.3.8

View File

@ -296,7 +296,6 @@ Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the
will contain an array of IPv4 addresses (e.g.
`['74.125.79.104', '74.125.79.105', '74.125.79.106']`).
## dns.resolve6(hostname[, options], callback)
<!-- YAML
added: v0.1.16
@ -320,7 +319,6 @@ Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the
`hostname`. The `addresses` argument passed to the `callback` function
will contain an array of IPv6 addresses.
## dns.resolveCname(hostname, callback)
<!-- YAML
added: v0.3.2

View File

@ -479,7 +479,6 @@ The following properties are provided:
* `dest` {Buffer} When reporting a file system error, the `dest` will identify
the file path destination (if any).
#### error.code
* {string}

View File

@ -572,7 +572,6 @@ myEmitter.emit('event');
myEmitter.emit('event');
// Prints:
// A
```
Because listeners are managed using an internal array, calling this will

View File

@ -4297,7 +4297,6 @@ Any specified `FileHandle` has to support writing.
It is unsafe to use `fsPromises.writeFile()` multiple times on the same file
without waiting for the `Promise` to be resolved (or rejected).
## FS Constants
The following constants are exported by `fs.constants`.

View File

@ -605,7 +605,6 @@ const contentLength = request.getHeader('Content-Length');
// contentLength is of type number
const setCookie = request.getHeader('set-cookie');
// setCookie is of type string[]
```
### request.removeHeader(name)
@ -1054,7 +1053,6 @@ response.end();
Attempting to set a header field name or value that contains invalid characters
will result in a [`TypeError`][] being thrown.
### response.connection
<!-- YAML
added: v0.3.0

View File

@ -3178,7 +3178,6 @@ following additional properties:
* `type` {string} Either `'server'` or `'client'` to identify the type of
`Http2Session`.
[ALPN negotiation]: #http2_alpn_negotiation
[ALPN Protocol ID]: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
[Compatibility API]: #http2_compatibility_api

View File

@ -165,7 +165,6 @@ changes:
- `agent` **Default:** `https.globalAgent`
- `callback` {Function}
Makes a request to a secure web server.
The following additional `options` from [`tls.connect()`][] are also accepted:
@ -326,9 +325,10 @@ req.on('error', (e) => {
console.error(e.message);
});
req.end();
```
Outputs for example:
Outputs for example:
```text
Subject Common Name: github.com
Certificate SHA256 fingerprint: 25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16

View File

@ -166,7 +166,6 @@ session.post('Profiler.enable', () => {
});
```
[`'Debugger.paused'`]: https://chromedevtools.github.io/devtools-protocol/v8/Debugger#event-paused
[`EventEmitter`]: events.html#events_class_eventemitter
[`session.connect()`]: #inspector_session_connect

View File

@ -729,7 +729,6 @@ a.on('ready', () => {
});
```
Note that assignment to `module.exports` must be done immediately. It cannot be
done in any callbacks. This does not work:

View File

@ -339,7 +339,6 @@ added: v8.5.0
The high resolution millisecond timestamp at which the V8 platform was
initialized.
## Class: PerformanceObserver
### new PerformanceObserver(callback)
@ -477,7 +476,6 @@ Returns a list of `PerformanceEntry` objects in chronological order
with respect to `performanceEntry.startTime` whose `performanceEntry.entryType`
is equal to `type`.
## Examples
### Measuring the duration of async operations

View File

@ -966,7 +966,6 @@ that started the Node.js process.
'/usr/local/bin/node'
```
## process.exit([code])
<!-- YAML
added: v0.1.13
@ -1046,7 +1045,6 @@ a code.
Specifying a code to [`process.exit(code)`][`process.exit()`] will override any
previous setting of `process.exitCode`.
## process.getegid()
<!-- YAML
added: v2.0.0
@ -1181,7 +1179,6 @@ setTimeout(() => {
}, 1000);
```
## process.initgroups(user, extraGroup)
<!-- YAML
added: v0.9.4
@ -1574,7 +1571,6 @@ if (process.getegid && process.setegid) {
This function is only available on POSIX platforms (i.e. not Windows or
Android).
## process.seteuid(id)
<!-- YAML
added: v2.0.0
@ -1870,7 +1866,6 @@ console.log(
);
```
## process.uptime()
<!-- YAML
added: v0.5.0
@ -1987,7 +1982,6 @@ cases:
For example, signal `SIGABRT` has value `6`, so the expected exit
code will be `128` + `6`, or `134`.
[`'exit'`]: #process_event_exit
[`'finish'`]: stream.html#stream_event_finish
[`'message'`]: child_process.html#child_process_event_message

View File

@ -134,7 +134,6 @@ added: v0.1.25
-->
* `str` {string}
The `querystring.unescape()` method performs decoding of URL percent-encoded
characters on the given `str`.

View File

@ -320,7 +320,6 @@ added: v0.7.7
The `readline.clearLine()` method clears current line of given [TTY][] stream
in a specified direction identified by `dir`.
## readline.clearScreenDown(stream)
<!-- YAML
added: v0.7.7
@ -477,7 +476,6 @@ added: v0.7.7
The `readline.moveCursor()` method moves the cursor *relative* to its current
position in a given [TTY][] `stream`.
## Example: Tiny CLI
The following example illustrates the use of `readline.Interface` class to

View File

@ -2422,7 +2422,6 @@ In addition to new Readable streams switching into flowing mode,
pre-v0.10 style streams can be wrapped in a Readable class using the
[`readable.wrap()`][`stream.wrap()`] method.
### `readable.read(0)`
There are some cases where it is necessary to trigger a refresh of the

View File

@ -230,7 +230,6 @@ added: v0.0.1
Cancels a `Timeout` object created by [`setTimeout()`][].
[`TypeError`]: errors.html#errors_class_typeerror
[`clearImmediate()`]: timers.html#timers_clearimmediate_immediate
[`clearInterval()`]: timers.html#timers_clearinterval_timeout

View File

@ -428,7 +428,6 @@ more information on how it is used.
Changes to the ticket keys are effective only for future server connections.
Existing or currently pending server connections will use the previous keys.
## Class: tls.TLSSocket
<!-- YAML
added: v0.11.4
@ -1008,7 +1007,6 @@ as arguments instead of options.
A port or host option, if specified, will take precedence over any port or host
argument.
## tls.createSecureContext(options)
<!-- YAML
added: v0.11.13
@ -1121,7 +1119,6 @@ If the 'ca' option is not given, then Node.js will use the default
publicly trusted list of CAs as given in
<https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt>.
## tls.createServer([options][, secureConnectionListener])
<!-- YAML
added: v0.3.2
@ -1264,7 +1261,6 @@ The default curve name to use for ECDH key agreement in a tls server. The
default value is `'auto'`. See [`tls.createSecureContext()`] for further
information.
## Deprecated APIs
### Class: CryptoStream

View File

@ -1061,7 +1061,6 @@ The formatting process operates as follows:
string, an [`Error`][] is thrown.
* `result` is returned.
### url.parse(urlString[, parseQueryString[, slashesDenoteHost]])
<!-- YAML
added: v0.1.25

View File

@ -356,7 +356,6 @@ stream.on('data', (data) => {
console.log(`Received data: "${data}"`);
});
stream.write('With ES6');
```
## util.inspect(object[, options])
@ -1554,7 +1553,6 @@ const module = new WebAssembly.Module(wasmBuffer);
util.types.isWebAssemblyCompiledModule(module); // Returns true
```
## Deprecated APIs
The following APIs have been deprecated and should no longer be used. Existing

View File

@ -472,7 +472,6 @@ changes:
during script execution, but will continue to work after that.
If execution is terminated, an [`Error`][] will be thrown.
Runs the compiled code contained by the `vm.Script` object within the given
`contextifiedSandbox` and returns the result. Running code does not have access
to local scope.