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/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/buffer.md4
-rw-r--r--doc/api/child_process.md8
-rw-r--r--doc/api/cli.md2
-rw-r--r--doc/api/crypto.md2
-rw-r--r--doc/api/deprecations.md2
-rw-r--r--doc/api/diagnostics_channel.md2
-rw-r--r--doc/api/dns.md8
-rw-r--r--doc/api/esm.md2
-rw-r--r--doc/api/events.md4
-rw-r--r--doc/api/fs.md12
-rw-r--r--doc/api/globals.md16
-rw-r--r--doc/api/http.md6
-rw-r--r--doc/api/http2.md6
-rw-r--r--doc/api/modules.md2
-rw-r--r--doc/api/process.md2
-rw-r--r--doc/api/readline.md2
-rw-r--r--doc/api/stream.md2
-rw-r--r--doc/api/url.md10
-rw-r--r--doc/api/util.md2
-rw-r--r--doc/api/worker_threads.md4
20 files changed, 49 insertions, 49 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 564c116665e..5759d54b5fa 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -3114,7 +3114,7 @@ accessed using `require('buffer')`.
### `buffer.atob(data)`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `data` {any} The Base64-encoded input string.
@@ -3133,7 +3133,7 @@ and binary data should be performed using `Buffer.from(str, 'base64')` and
### `buffer.btoa(data)`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `data` {any} An ASCII (Latin1) string.
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index a78ba0e016e..68931d0a860 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -250,7 +250,7 @@ lsExample();
<!-- YAML
added: v0.1.91
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/36308
description: AbortSignal support was added.
- version: v8.8.0
@@ -351,7 +351,7 @@ controller.abort();
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/36603
description: AbortSignal support was added.
- version:
@@ -431,7 +431,7 @@ The `signal` option works exactly the same way it does in
<!-- YAML
added: v0.1.90
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/36432
description: AbortSignal support was added.
- version:
@@ -1086,7 +1086,7 @@ See [Advanced serialization][] for more details.
### Event: `'spawn'`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
The `'spawn'` event is emitted once the child process has spawned successfully.
diff --git a/doc/api/cli.md b/doc/api/cli.md
index ee659f49df6..e8d79853d70 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -199,7 +199,7 @@ Currently, overriding `Error.prepareStackTrace` is ignored when the
### `--experimental-abortcontroller`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
Enable experimental `AbortController` and `AbortSignal` support.
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index e82ae7ad70b..97574d7c484 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -2843,7 +2843,7 @@ console.log(`The dice rolled: ${n}`);
### `crypto.randomUUID([options])`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `options` {Object}
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 3f78df5646e..7e1cd082602 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -2148,7 +2148,7 @@ future release.
### DEP0116: Legacy URL API
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
diff --git a/doc/api/diagnostics_channel.md b/doc/api/diagnostics_channel.md
index 47796709eb9..f120f34f26f 100644
--- a/doc/api/diagnostics_channel.md
+++ b/doc/api/diagnostics_channel.md
@@ -1,6 +1,6 @@
# Diagnostics Channel
-<!--introduced_in=REPLACEME-->
+<!--introduced_in=v14.17.0-->
> Stability: 1 - Experimental
diff --git a/doc/api/dns.md b/doc/api/dns.md
index 9933e77e8a5..b448d7d6752 100644
--- a/doc/api/dns.md
+++ b/doc/api/dns.md
@@ -119,7 +119,7 @@ callbacks will be called with an error with code `ECANCELLED`.
### `resolver.setLocalAddress([ipv4][, ipv6])`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `ipv4` {string} A string representation of an IPv4 address.
@@ -437,7 +437,7 @@ will contain an array of canonical name records available for the `hostname`
## `dns.resolveCaa(hostname, callback)`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `hostname` {string}
@@ -718,7 +718,7 @@ The following methods from the `dnsPromises` API are available:
### `resolver.cancel()`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
Cancel all outstanding DNS queries made by this resolver. The corresponding
@@ -946,7 +946,7 @@ Here is an example of the result object:
### `dnsPromises.resolveCaa(hostname)`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `hostname` {string}
diff --git a/doc/api/esm.md b/doc/api/esm.md
index 04b3d049281..21f89c9bca4 100644
--- a/doc/api/esm.md
+++ b/doc/api/esm.md
@@ -6,7 +6,7 @@
added: v8.5.0
changes:
- version:
- - REPLACEME
+ - v14.17.0
pr-url: https://github.com/nodejs/node/pull/35781
description: Stabilize modules implementation.
- version:
diff --git a/doc/api/events.md b/doc/api/events.md
index 3d9bfdf28b4..48df1eaa78f 100644
--- a/doc/api/events.md
+++ b/doc/api/events.md
@@ -385,7 +385,7 @@ regular `'error'` listener is installed.
### `EventEmitter.setMaxListeners(n[, ...eventTargets])`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `n` {number} A non-negative number. The maximum number of listeners per
@@ -855,7 +855,7 @@ class MyClass extends EventEmitter {
## `events.getEventListeners(emitterOrTarget, eventName)`
<!-- YAML
added:
- - REPLACEME
+ - v14.17.0
-->
* `emitterOrTarget` {EventEmitter|EventTarget}
* `eventName` {string|symbol}
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 2e9017afed4..e64d70d6da8 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1612,7 +1612,7 @@ See also: chown(2).
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37174
description: A default callback is now used if one is not provided.
- version: v10.0.0
@@ -3031,7 +3031,7 @@ If `options.withFileTypes` is set to `true`, the result will contain
<!-- YAML
added: v0.1.29
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/35911
description: The options argument may include an AbortSignal to abort an
ongoing readFile request.
@@ -4083,7 +4083,7 @@ this API: [`fs.utimes()`][].
<!-- YAML
added: v0.5.10
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37190
description: Added support for closing the watcher with an AbortSignal.
- version: v7.6.0
@@ -4405,7 +4405,7 @@ details.
<!-- YAML
added: v0.1.29
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/35993
description: The options argument may include an AbortSignal to abort an
ongoing writeFile request.
@@ -5491,7 +5491,7 @@ print('./').catch(console.error);
<!-- YAML
added: v10.0.0
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/35911
description: The options argument may include an AbortSignal to abort an
ongoing readFile request.
@@ -5741,7 +5741,7 @@ The `atime` and `mtime` arguments follow these rules:
<!-- YAML
added: v10.0.0
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/35993
description: The options argument may include an AbortSignal to abort an
ongoing writeFile request.
diff --git a/doc/api/globals.md b/doc/api/globals.md
index 0f84a868805..e577372b5c4 100644
--- a/doc/api/globals.md
+++ b/doc/api/globals.md
@@ -19,7 +19,7 @@ accessible.
## Class: `AbortController`
<!--YAML
-added: REPLACEME
+added: v14.17.0
-->
> Stability: 1 - Experimental
@@ -44,7 +44,7 @@ console.log(ac.signal.aborted); // Prints True
### `abortController.abort()`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
Triggers the abort signal, causing the `abortController.signal` to emit
@@ -52,14 +52,14 @@ the `'abort'` event.
### `abortController.signal`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Type: {AbortSignal}
### Class: `AbortSignal`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Extends: {EventTarget}
@@ -69,7 +69,7 @@ The `AbortSignal` is used to notify observers when the
#### Static method: `AbortSignal.abort()`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Returns: {AbortSignal}
@@ -78,7 +78,7 @@ Returns a new already aborted `AbortSignal`.
#### Event: `'abort'`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
The `'abort'` event is emitted when the `abortController.abort()` method
@@ -112,14 +112,14 @@ result in memory leaks.
#### `abortSignal.aborted`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Type: {boolean} True after the `AbortController` has been aborted.
#### `abortSignal.onabort`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Type: {Function}
diff --git a/doc/api/http.md b/doc/api/http.md
index 12ae7b5e516..68e2b68ab86 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -113,7 +113,7 @@ http.get({
<!-- YAML
added: v0.3.4
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/36685
description: Change the default scheduling from 'fifo' to 'lifo'.
- version: v14.5.0
@@ -758,7 +758,7 @@ const cookie = request.getHeader('Cookie');
### `request.getRawHeaderNames()`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Returns: {string[]}
@@ -2364,7 +2364,7 @@ This can be overridden for servers and client requests by passing the
<!-- YAML
added: v0.3.6
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/36048
description: It is possible to abort a request with an AbortSignal.
- version:
diff --git a/doc/api/http2.md b/doc/api/http2.md
index aa664d7186f..99567db6b1e 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -2,7 +2,7 @@
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/36070
description: It is possible to abort a request with an AbortSignal.
- version: v10.10.0
@@ -1880,7 +1880,7 @@ value only affects new connections to the server, not any existing connections.
#### `server.updateSettings([settings])`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `settings` {HTTP/2 Settings Object}
@@ -2074,7 +2074,7 @@ value only affects new connections to the server, not any existing connections.
#### `server.updateSettings([settings])`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `settings` {HTTP/2 Settings Object}
diff --git a/doc/api/modules.md b/doc/api/modules.md
index 1e6e72216f3..a2c697fe23a 100644
--- a/doc/api/modules.md
+++ b/doc/api/modules.md
@@ -891,7 +891,7 @@ filename.
### `module.isPreloading`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Type: {boolean} `true` if the module is running during the Node.js preload
diff --git a/doc/api/process.md b/doc/api/process.md
index edc4a771420..3da63f0609b 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1986,7 +1986,7 @@ Additional documentation is available in the [report documentation][].
added: v11.12.0
changes:
- version:
- - REPLACEME
+ - v14.17.0
pr-url: https://github.com/nodejs/node/pull/35654
description: This API is no longer experimental.
-->
diff --git a/doc/api/readline.md b/doc/api/readline.md
index 4c12427b32e..ac6a8b9b14c 100644
--- a/doc/api/readline.md
+++ b/doc/api/readline.md
@@ -285,7 +285,7 @@ whenever `rl.prompt()` is called.
### `rl.getPrompt()`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Returns: {string} the current prompt string
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 86e1eb35068..ce30cde32f0 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -576,7 +576,7 @@ the status of the `highWaterMark`.
##### `writable.writableNeedDrain`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* {boolean}
diff --git a/doc/api/url.md b/doc/api/url.md
index b5d1c95f3cb..b18a5863958 100644
--- a/doc/api/url.md
+++ b/doc/api/url.md
@@ -1039,7 +1039,7 @@ pathToFileURL('/some/path%.c'); // Correct: file:///some/path%25.c (POSIX)
## Legacy URL API
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
@@ -1052,7 +1052,7 @@ changes:
### Legacy `urlObject`
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
@@ -1166,7 +1166,7 @@ forward-slash characters (`/`) are required following the colon in the
<!-- YAML
added: v0.1.25
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
@@ -1262,7 +1262,7 @@ The formatting process operates as follows:
<!-- YAML
added: v0.1.25
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.14.0
@@ -1309,7 +1309,7 @@ incorrect handling of usernames and passwords have been identified.
<!-- YAML
added: v0.1.25
changes:
- - version: REPLACEME
+ - version: v14.17.0
pr-url: https://github.com/nodejs/node/pull/37784
description: Deprecation revoked. Status changed to "Legacy".
- version: v11.0.0
diff --git a/doc/api/util.md b/doc/api/util.md
index e52c54176da..daba992b89d 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -378,7 +378,7 @@ fs.access('file/that/does/not/exist', (err) => {
## `util.getSystemErrorMap()`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* Returns: {Map}
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
index def3e414e08..7b414a5d1a2 100644
--- a/doc/api/worker_threads.md
+++ b/doc/api/worker_threads.md
@@ -795,7 +795,7 @@ immediately with an [`ERR_WORKER_NOT_RUNNING`][] error.
### `worker.performance`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
An object that can be used to query performance information from a worker
@@ -803,7 +803,7 @@ instance. Similar to [`perf_hooks.performance`][].
#### `performance.eventLoopUtilization([utilization1[, utilization2]])`
<!-- YAML
-added: REPLACEME
+added: v14.17.0
-->
* `utilization1` {Object} The result of a previous call to
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-17 10:53:38 +0300