Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2020-11-09 16:44:32 +0300
committerNode.js GitHub Bot <github-bot@iojs.org>2020-11-12 09:29:49 +0300
commita783f9bc2249f7d6d9a48fa343aecf5ce5ed21a3 (patch)
treee80426866d8a3e7dc92882a9ad6a2edd26b51c8b /doc
parentba73f93f0205cdd0f1d96032694b40a1727a781a (diff)
doc: update list styles for remark-parse@9 rendering
remark-parse@9.0.0 combined with our html.js tool ends a list if a multi-line item does not include indentation. Update our docs for this formatting. I looked around for a lint rule to enforce this but didn't find one readily available. (Happy to be shown that I'm wrong about that!) We may need to write one. PR-URL: https://github.com/nodejs/node/pull/36049 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/addons.md31
-rw-r--r--doc/api/assert.md2
-rw-r--r--doc/api/async_hooks.md16
-rw-r--r--doc/api/debugger.md14
-rw-r--r--doc/api/dns.md10
-rw-r--r--doc/api/fs.md44
-rw-r--r--doc/api/http.md6
-rw-r--r--doc/api/http2.md2
-rw-r--r--doc/api/https.md2
-rw-r--r--doc/api/modules.md2
-rw-r--r--doc/api/n-api.md20
-rw-r--r--doc/api/report.md34
-rw-r--r--doc/api/stream.md6
-rw-r--r--doc/api/string_decoder.md4
-rw-r--r--doc/api/tls.md18
-rw-r--r--doc/api/util.md4
16 files changed, 108 insertions, 107 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md
index 0d8261d7c66..796e32248f8 100644
--- a/doc/api/addons.md
+++ b/doc/api/addons.md
@@ -154,25 +154,26 @@ they were created.
The context-aware addon can be structured to avoid global static data by
performing the following steps:
+
* Define a class which will hold per-addon-instance data and which has a static
-member of the form
+ member of the form
```cpp
static void DeleteInstance(void* data) {
// Cast `data` to an instance of the class and delete it.
}
```
* Heap-allocate an instance of this class in the addon initializer. This can be
-accomplished using the `new` keyword.
+ accomplished using the `new` keyword.
* Call `node::AddEnvironmentCleanupHook()`, passing it the above-created
-instance and a pointer to `DeleteInstance()`. This will ensure the instance is
-deleted when the environment is torn down.
+ instance and a pointer to `DeleteInstance()`. This will ensure the instance is
+ deleted when the environment is torn down.
* Store the instance of the class in a `v8::External`, and
* Pass the `v8::External` to all methods exposed to JavaScript by passing it
-to `v8::FunctionTemplate::New()` or `v8::Function::New()` which creates the
-native-backed JavaScript functions. The third parameter of
-`v8::FunctionTemplate::New()` or `v8::Function::New()` accepts the
-`v8::External` and makes it available in the native callback using the
-`v8::FunctionCallbackInfo::Data()` method.
+ to `v8::FunctionTemplate::New()` or `v8::Function::New()` which creates the
+ native-backed JavaScript functions. The third parameter of
+ `v8::FunctionTemplate::New()` or `v8::Function::New()` accepts the
+ `v8::External` and makes it available in the native callback using the
+ `v8::FunctionCallbackInfo::Data()` method.
This will ensure that the per-addon-instance data reaches each binding that can
be called from JavaScript. The per-addon-instance data must also be passed into
@@ -397,14 +398,14 @@ the appropriate headers automatically. However, there are a few caveats to be
aware of:
* When `node-gyp` runs, it will detect the specific release version of Node.js
-and download either the full source tarball or just the headers. If the full
-source is downloaded, addons will have complete access to the full set of
-Node.js dependencies. However, if only the Node.js headers are downloaded, then
-only the symbols exported by Node.js will be available.
+ and download either the full source tarball or just the headers. If the full
+ source is downloaded, addons will have complete access to the full set of
+ Node.js dependencies. However, if only the Node.js headers are downloaded,
+ then only the symbols exported by Node.js will be available.
* `node-gyp` can be run using the `--nodedir` flag pointing at a local Node.js
-source image. Using this option, the addon will have access to the full set of
-dependencies.
+ source image. Using this option, the addon will have access to the full set of
+ dependencies.
### Loading addons using `require()`
diff --git a/doc/api/assert.md b/doc/api/assert.md
index 54e4bc172ab..f32d11c6eda 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -237,7 +237,7 @@ added:
-->
* Returns: {Array} of objects containing information about the wrapper functions
-returned by [`tracker.calls()`][].
+ returned by [`tracker.calls()`][].
* Object {Object}
* `message` {string}
* `actual` {number} The actual number of times the function was called.
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
index f54e82ee46b..08111b67a85 100644
--- a/doc/api/async_hooks.md
+++ b/doc/api/async_hooks.md
@@ -699,14 +699,14 @@ asyncResource.triggerAsyncId();
* `type` {string} The type of async event.
* `options` {Object}
* `triggerAsyncId` {number} The ID of the execution context that created this
- async event. **Default:** `executionAsyncId()`.
+ async event. **Default:** `executionAsyncId()`.
* `requireManualDestroy` {boolean} If set to `true`, disables `emitDestroy`
- when the object is garbage collected. This usually does not need to be set
- (even if `emitDestroy` is called manually), unless the resource's `asyncId`
- is retrieved and the sensitive API's `emitDestroy` is called with it.
- When set to `false`, the `emitDestroy` call on garbage collection
- will only take place if there is at least one active `destroy` hook.
- **Default:** `false`.
+ when the object is garbage collected. This usually does not need to be set
+ (even if `emitDestroy` is called manually), unless the resource's `asyncId`
+ is retrieved and the sensitive API's `emitDestroy` is called with it.
+ When set to `false`, the `emitDestroy` call on garbage collection
+ will only take place if there is at least one active `destroy` hook.
+ **Default:** `false`.
Example usage:
@@ -791,7 +791,7 @@ never be called.
#### `asyncResource.triggerAsyncId()`
* Returns: {number} The same `triggerAsyncId` that is passed to the
-`AsyncResource` constructor.
+ `AsyncResource` constructor.
<a id="async-resource-worker-pool"></a>
### Using `AsyncResource` for a `Worker` thread pool
diff --git a/doc/api/debugger.md b/doc/api/debugger.md
index 89980cfbd4a..b6dd45c7000 100644
--- a/doc/api/debugger.md
+++ b/doc/api/debugger.md
@@ -115,14 +115,14 @@ To begin watching an expression, type `watch('my_expression')`. The command
* `setBreakpoint()`, `sb()`: Set breakpoint on current line
* `setBreakpoint(line)`, `sb(line)`: Set breakpoint on specific line
* `setBreakpoint('fn()')`, `sb(...)`: Set breakpoint on a first statement in
-functions body
+ functions body
* `setBreakpoint('script.js', 1)`, `sb(...)`: Set breakpoint on first line of
-`script.js`
+ `script.js`
* `setBreakpoint('script.js', 1, 'num < 4')`, `sb(...)`: Set conditional
-breakpoint on first line of `script.js` that only breaks when `num < 4`
-evaluates to `true`
+ breakpoint on first line of `script.js` that only breaks when `num < 4`
+ evaluates to `true`
* `clearBreakpoint('script.js', 1)`, `cb(...)`: Clear breakpoint in `script.js`
-on line 1
+ on line 1
It is also possible to set a breakpoint in a file (module) that
is not loaded yet:
@@ -188,11 +188,11 @@ debug>
* `backtrace`, `bt`: Print backtrace of current execution frame
* `list(5)`: List scripts source code with 5 line context (5 lines before and
-after)
+ after)
* `watch(expr)`: Add expression to watch list
* `unwatch(expr)`: Remove expression from watch list
* `watchers`: List all watchers and their values (automatically listed on each
-breakpoint)
+ breakpoint)
* `repl`: Open debugger's repl for evaluation in debugging script's context
* `exec expr`: Execute an expression in debugging script's context
diff --git a/doc/api/dns.md b/doc/api/dns.md
index a284c9d0c57..613bd2465b9 100644
--- a/doc/api/dns.md
+++ b/doc/api/dns.md
@@ -250,13 +250,13 @@ changes:
The following flags can be passed as hints to [`dns.lookup()`][].
* `dns.ADDRCONFIG`: Limits returned address types to the types of non-loopback
-addresses configured on the system. For example, IPv4 addresses are only
-returned if the current system has at least one IPv4 address configured.
+ addresses configured on the system. For example, IPv4 addresses are only
+ returned if the current system has at least one IPv4 address configured.
* `dns.V4MAPPED`: If the IPv6 family was specified, but no IPv6 addresses were
-found, then return IPv4 mapped IPv6 addresses. It is not supported
-on some operating systems (e.g FreeBSD 10.1).
+ found, then return IPv4 mapped IPv6 addresses. It is not supported
+ on some operating systems (e.g FreeBSD 10.1).
* `dns.ALL`: If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as
-well as IPv4 mapped IPv6 addresses.
+ well as IPv4 mapped IPv6 addresses.
## `dns.lookupService(address, port, callback)`
<!-- YAML
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 065ae645652..0ee98e5646a 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1678,13 +1678,13 @@ OR of two or more values (e.g.
`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
* `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
-exists.
+ exists.
* `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
-copy-on-write reflink. If the platform does not support copy-on-write, then a
-fallback copy mechanism is used.
+ copy-on-write reflink. If the platform does not support copy-on-write, then a
+ fallback copy mechanism is used.
* `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
-create a copy-on-write reflink. If the platform does not support copy-on-write,
-then the operation will fail.
+ create a copy-on-write reflink. If the platform does not support
+ copy-on-write, then the operation will fail.
```js
const fs = require('fs');
@@ -1727,13 +1727,13 @@ OR of two or more values (e.g.
`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
* `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
-exists.
+ exists.
* `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
-copy-on-write reflink. If the platform does not support copy-on-write, then a
-fallback copy mechanism is used.
+ copy-on-write reflink. If the platform does not support copy-on-write, then a
+ fallback copy mechanism is used.
* `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
-create a copy-on-write reflink. If the platform does not support copy-on-write,
-then the operation will fail.
+ create a copy-on-write reflink. If the platform does not support
+ copy-on-write, then the operation will fail.
```js
const fs = require('fs');
@@ -1780,7 +1780,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `flags` {string} See [support of file system `flags`][]. **Default:**
- `'r'`.
+ `'r'`.
* `encoding` {string} **Default:** `null`
* `fd` {integer} **Default:** `null`
* `mode` {integer} **Default:** `0o666`
@@ -1885,7 +1885,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `flags` {string} See [support of file system `flags`][]. **Default:**
- `'w'`.
+ `'w'`.
* `encoding` {string} **Default:** `'utf8'`
* `fd` {integer} **Default:** `null`
* `mode` {integer} **Default:** `0o666`
@@ -3129,11 +3129,11 @@ system requests but rather the internal buffering `fs.readFile` performs.
1. Any specified file descriptor has to support reading.
2. If a file descriptor is specified as the `path`, it will not be closed
-automatically.
+ automatically.
3. The reading will begin at the current position. For example, if the file
-already had `'Hello World`' and six bytes are read with the file descriptor,
-the call to `fs.readFile()` with the same file descriptor, would give
-`'World'`, rather than `'Hello World'`.
+ already had `'Hello World`' and six bytes are read with the file descriptor,
+ the call to `fs.readFile()` with the same file descriptor, would give
+ `'World'`, rather than `'Hello World'`.
## `fs.readFileSync(path[, options])`
<!-- YAML
@@ -5227,13 +5227,13 @@ OR of two or more values (e.g.
`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
* `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
-exists.
+ exists.
* `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
-copy-on-write reflink. If the platform does not support copy-on-write, then a
-fallback copy mechanism is used.
+ copy-on-write reflink. If the platform does not support copy-on-write, then a
+ fallback copy mechanism is used.
* `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
-create a copy-on-write reflink. If the platform does not support copy-on-write,
-then the operation will fail.
+ create a copy-on-write reflink. If the platform does not support
+ copy-on-write, then the operation will fail.
```js
const {
@@ -6133,7 +6133,7 @@ string.
* `'wx'`: Like `'w'` but fails if the path exists.
* `'w+'`: Open file for reading and writing.
-The file is created (if it does not exist) or truncated (if it exists).
+ The file is created (if it does not exist) or truncated (if it exists).
* `'wx+'`: Like `'w+'` but fails if the path exists.
diff --git a/doc/api/http.md b/doc/api/http.md
index 4ce2c9251a2..5b19255b579 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -1997,9 +1997,9 @@ Duplicates in raw headers are handled in the following ways, depending on the
header name:
* Duplicates of `age`, `authorization`, `content-length`, `content-type`,
-`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
-`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
-`retry-after`, `server`, or `user-agent` are discarded.
+ `etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
+ `last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
+ `retry-after`, `server`, or `user-agent` are discarded.
* `set-cookie` is always an array. Duplicates are added to the array.
* For duplicate `cookie` headers, the values are joined together with '; '.
* For all other headers, the values are joined together with ', '.
diff --git a/doc/api/http2.md b/doc/api/http2.md
index d09d093f3a7..516b9f6aa10 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -1429,7 +1429,7 @@ added: v8.4.0
* `err` {Error}
* `pushStream` {ServerHttp2Stream} The returned `pushStream` object.
* `headers` {HTTP/2 Headers Object} Headers object the `pushStream` was
- initiated with.
+ initiated with.
Initiates a push stream. The callback is invoked with the new `Http2Stream`
instance created for the push stream passed as the second argument, or an
diff --git a/doc/api/https.md b/doc/api/https.md
index d8906868a34..b322c3ee147 100644
--- a/doc/api/https.md
+++ b/doc/api/https.md
@@ -161,7 +161,7 @@ added: v0.3.4
-->
* `options` {Object} Accepts `options` from [`tls.createServer()`][],
- [`tls.createSecureContext()`][] and [`http.createServer()`][].
+ [`tls.createSecureContext()`][] and [`http.createServer()`][].
* `requestListener` {Function} A listener to be added to the `'request'` event.
* Returns: {https.Server}
diff --git a/doc/api/modules.md b/doc/api/modules.md
index 03d919f37fd..8648ec3ee79 100644
--- a/doc/api/modules.md
+++ b/doc/api/modules.md
@@ -503,7 +503,7 @@ wrapper that looks like the following:
By doing this, Node.js achieves a few things:
* It keeps top-level variables (defined with `var`, `const` or `let`) scoped to
-the module rather than the global object.
+ the module rather than the global object.
* It helps to provide some global-looking variables that are actually specific
to the module, such as:
* The `module` and `exports` objects that the implementor can use to export
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index 9f16d2d2933..615237c76bc 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -864,8 +864,8 @@ typedef void (*napi_async_cleanup_hook)(napi_async_cleanup_hook_handle handle,
```
* `[in] handle`: The handle that must be passed to
-[`napi_remove_async_cleanup_hook`][] after completion of the asynchronous
-cleanup.
+ [`napi_remove_async_cleanup_hook`][] after completion of the asynchronous
+ cleanup.
* `[in] data`: The data that was passed to [`napi_add_async_cleanup_hook`][].
The body of the function should initiate the asynchronous cleanup actions at the
@@ -945,7 +945,7 @@ napi_get_last_error_info(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[out] result`: The `napi_extended_error_info` structure with more
-information about the error.
+ information about the error.
Returns `napi_ok` if the API succeeded.
@@ -1725,7 +1725,7 @@ NAPI_EXTERN napi_status napi_add_async_cleanup_hook(
* `[in] hook`: The function pointer to call at environment teardown.
* `[in] arg`: The pointer to pass to `hook` when it gets called.
* `[out] remove_handle`: Optional handle that refers to the asynchronous cleanup
-hook.
+ hook.
Registers `hook`, which is a function of type [`napi_async_cleanup_hook`][], as
a function to be run with the `remove_handle` and `arg` parameters once the
@@ -1762,7 +1762,7 @@ NAPI_EXTERN napi_status napi_remove_async_cleanup_hook(
```
* `[in] remove_handle`: The handle to an asynchronous cleanup hook that was
-created with [`napi_add_async_cleanup_hook`][].
+ created with [`napi_add_async_cleanup_hook`][].
Unregisters the cleanup hook corresponding to `remove_handle`. This will prevent
the hook from being executed, unless it has already started executing.
@@ -3372,7 +3372,7 @@ napi_status napi_typeof(napi_env env, napi_value value, napi_valuetype* result)
Returns `napi_ok` if the API succeeded.
* `napi_invalid_arg` if the type of `value` is not a known ECMAScript type and
- `value` is not an External value.
+ `value` is not an External value.
This API represents behavior similar to invoking the `typeof` Operator on
the object as defined in [Section 12.5.5][] of the ECMAScript Language
@@ -3902,11 +3902,11 @@ napi_get_all_property_names(napi_env env,
* `[in] object`: The object from which to retrieve the properties.
* `[in] key_mode`: Whether to retrieve prototype properties as well.
* `[in] key_filter`: Which properties to retrieve
-(enumerable/readable/writable).
+ (enumerable/readable/writable).
* `[in] key_conversion`: Whether to convert numbered property keys to strings.
* `[out] result`: A `napi_value` representing an array of JavaScript values
-that represent the property names of the object. [`napi_get_array_length`][] and
-[`napi_get_element`][] can be used to iterate over `result`.
+ that represent the property names of the object. [`napi_get_array_length`][]
+ and [`napi_get_element`][] can be used to iterate over `result`.
Returns `napi_ok` if the API succeeded.
@@ -4942,7 +4942,7 @@ napi_status napi_check_object_type_tag(napi_env env,
* `[in] js_object`: The JavaScript object whose type tag to examine.
* `[in] type_tag`: The tag with which to compare any tag found on the object.
* `[out] result`: Whether the type tag given matched the type tag on the
-object. `false` is also returned if no type tag was found on the object.
+ object. `false` is also returned if no type tag was found on the object.
Returns `napi_ok` if the API succeeded.
diff --git a/doc/api/report.md b/doc/api/report.md
index b62de913be2..9ee65280a8a 100644
--- a/doc/api/report.md
+++ b/doc/api/report.md
@@ -396,15 +396,15 @@ node --report-uncaught-exception --report-on-signal \
```
* `--report-uncaught-exception` Enables report to be generated on
-un-caught exceptions. Useful when inspecting JavaScript stack in conjunction
-with native stack and other runtime environment data.
+ un-caught exceptions. Useful when inspecting JavaScript stack in conjunction
+ with native stack and other runtime environment data.
* `--report-on-signal` Enables report to be generated upon receiving
-the specified (or predefined) signal to the running Node.js process. (See below
-on how to modify the signal that triggers the report.) Default signal is `SIGUSR2`.
-Useful when a report needs to be triggered from another program.
-Application monitors may leverage this feature to collect report at regular
-intervals and plot rich set of internal runtime data to their views.
+ the specified (or predefined) signal to the running Node.js process. (See
+ below on how to modify the signal that triggers the report.) Default signal is
+ `SIGUSR2`. Useful when a report needs to be triggered from another program.
+ Application monitors may leverage this feature to collect report at regular
+ intervals and plot rich set of internal runtime data to their views.
Signal based report generation is not supported in Windows.
@@ -413,24 +413,24 @@ signal. However, if `SIGUSR2` is already used for other purposes, then this
flag helps to change the signal for report generation and preserve the original
meaning of `SIGUSR2` for the said purposes.
-* `--report-on-fatalerror` Enables the report to be triggered on
-fatal errors (internal errors within the Node.js runtime, such as out of memory)
-that leads to termination of the application. Useful to inspect various
-diagnostic data elements such as heap, stack, event loop state, resource
-consumption etc. to reason about the fatal error.
+* `--report-on-fatalerror` Enables the report to be triggered on fatal errors
+ (internal errors within the Node.js runtime, such as out of memory)
+ that leads to termination of the application. Useful to inspect various
+ diagnostic data elements such as heap, stack, event loop state, resource
+ consumption etc. to reason about the fatal error.
* `--report-compact` Write reports in a compact format, single-line JSON, more
-easily consumable by log processing systems than the default multi-line format
-designed for human consumption.
+ easily consumable by log processing systems than the default multi-line format
+ designed for human consumption.
* `--report-directory` Location at which the report will be
-generated.
+ generated.
* `--report-filename` Name of the file to which the report will be
-written.
+ written.
* `--report-signal` Sets or resets the signal for report generation
-(not supported on Windows). Default signal is `SIGUSR2`.
+ (not supported on Windows). Default signal is `SIGUSR2`.
A report can also be triggered via an API call from a JavaScript application:
diff --git a/doc/api/stream.md b/doc/api/stream.md
index f0a81811194..6a22446743e 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -701,11 +701,11 @@ A [`Readable`][] stream can be in object mode or not, regardless of whether
it is in flowing mode or paused mode.
* In flowing mode, data is read from the underlying system automatically
-and provided to an application as quickly as possible using events via the
-[`EventEmitter`][] interface.
+ and provided to an application as quickly as possible using events via the
+ [`EventEmitter`][] interface.
* In paused mode, the [`stream.read()`][stream-read] method must be called
-explicitly to read chunks of data from the stream.
+ explicitly to read chunks of data from the stream.
All [`Readable`][] streams begin in paused mode but can be switched to flowing
mode in one of the following ways:
diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md
index 819283e5117..e0e1323cf33 100644
--- a/doc/api/string_decoder.md
+++ b/doc/api/string_decoder.md
@@ -62,7 +62,7 @@ added: v0.9.3
-->
* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
- `DataView` containing the bytes to decode.
+ `DataView` containing the bytes to decode.
* Returns: {string}
Returns any remaining input stored in the internal buffer as a string. Bytes
@@ -84,7 +84,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
- `DataView` containing the bytes to decode.
+ `DataView` containing the bytes to decode.
* Returns: {string}
Returns a decoded string, ensuring that any incomplete multibyte characters at
diff --git a/doc/api/tls.md b/doc/api/tls.md
index 128fac46064..bedf4e28e7b 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -644,7 +644,7 @@ added: v0.3.2
-->
* `callback` {Function} A listener callback that will be registered to listen
-for the server instance's `'close'` event.
+ for the server instance's `'close'` event.
* Returns: {tls.Server}
The `server.close()` method stops the server from accepting new connections.
@@ -975,8 +975,8 @@ added: v9.9.0
-->
* Returns: {Buffer|undefined} The latest `Finished` message that has been
-sent to the socket as part of a SSL/TLS handshake, or `undefined` if
-no `Finished` message has been sent yet.
+ sent to the socket as part of a SSL/TLS handshake, or `undefined` if
+ no `Finished` message has been sent yet.
As the `Finished` messages are message digests of the complete handshake
(with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can
@@ -1033,7 +1033,7 @@ certificate.
`'2A:7A:C2:DD:...'`.
* `ext_key_usage` {Array} (Optional) The extended key usage, a set of OIDs.
* `subjectaltname` {string} (Optional) A string containing concatenated names
- for the subject, an alternative to the `subject` names.
+ for the subject, an alternative to the `subject` names.
* `infoAccess` {Array} (Optional) An array describing the AuthorityInfoAccess,
used with OCSP.
* `issuerCertificate` {Object} (Optional) The issuer certificate object. For
@@ -1099,8 +1099,8 @@ added: v9.9.0
-->
* Returns: {Buffer|undefined} The latest `Finished` message that is expected
-or has actually been received from the socket as part of a SSL/TLS handshake,
-or `undefined` if there is no `Finished` message so far.
+ or has actually been received from the socket as part of a SSL/TLS handshake,
+ or `undefined` if there is no `Finished` message so far.
As the `Finished` messages are message digests of the complete handshake
(with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can
@@ -1155,7 +1155,7 @@ added: v12.11.0
-->
* Returns: {Array} List of signature algorithms shared between the server and
-the client in the order of decreasing preference.
+ the client in the order of decreasing preference.
See
[SSL_get_shared_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html)
@@ -1170,8 +1170,8 @@ added:
* `length` {number} number of bytes to retrieve from keying material
* `label` {string} an application specific label, typically this will be a
-value from the
-[IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels).
+ value from the
+ [IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels).
* `context` {Buffer} Optionally provide a context.
* Returns: {Buffer} requested bytes of the keying material
diff --git a/doc/api/util.md b/doc/api/util.md
index 1cd8fef07e2..4a506b18b70 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -78,7 +78,7 @@ added: v0.11.3
* `section` {string} A string identifying the portion of the application for
which the `debuglog` function is being created.
* `callback` {Function} A callback invoked the first time the logging function
-is called with a function argument that is a more optimized logging function.
+ is called with a function argument that is a more optimized logging function.
* Returns: {Function} The logging function
The `util.debuglog()` method is used to create a function that conditionally
@@ -1073,7 +1073,7 @@ changes:
-->
* {symbol} that can be used to declare custom promisified variants of functions,
-see [Custom promisified functions][].
+ see [Custom promisified functions][].
In addition to being accessible through `util.promisify.custom`, this
symbol is [registered globally][global symbol registry] and can be