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:
authorShelley Vohr <shelley.vohr@gmail.com>2020-06-28 06:26:32 +0300
committerShelley Vohr <shelley.vohr@gmail.com>2020-07-01 01:27:43 +0300
commiteb8fc2bf0f9283eb10751927de8c59e1a985366d (patch)
treea78751aedb820cb6f4837be029732300bb96c6f9 /doc/api
parent0edeeec3ec317bb8ed3bc9f6289eb9e7bfe0c61b (diff)
2020-06-30, Version 14.5.0 (Current)
Notable changes: build: * (SEMVER-MINOR) reset embedder string to "-node.0" (Michaël Zasso) https://github.com/nodejs/node/pull/33376 cli: * (SEMVER-MINOR) add alias for report-directory to make it consistent (AshCripps) https://github.com/nodejs/node/pull/33587 crypto: * (SEMVER-MINOR) allow KeyObjects in postMessage (Tobias Nießen) https://github.com/nodejs/node/pull/33360 deps: * (SEMVER-MINOR) V8: cherry-pick 0d6debcc5f08 (Michaël Zasso) https://github.com/nodejs/node/pull/33376 * (SEMVER-MINOR) update V8 to 8.3.110.9 (Michaël Zasso) https://github.com/nodejs/node/pull/33376 dgram: * (SEMVER-MINOR) allow typed arrays in .send() (Sarat Addepalli) https://github.com/nodejs/node/pull/22413 events: * (SEMVER-MINOR) initial implementation of experimental EventTarget (James M Snell) https://github.com/nodejs/node/pull/33556 fs: * (SEMVER-MINOR) implement lutimes (Maël Nison) https://github.com/nodejs/node/pull/33399 http: * (SEMVER-MINOR) expose host and protocol on ClientRequest (wenningplus) https://github.com/nodejs/node/pull/33803 * (SEMVER-MINOR) add maxTotalSockets to agent class (rickyes) https://github.com/nodejs/node/pull/33617 * (SEMVER-MINOR) return this from OutgoingMessage#destroy() (Colin Ihrig) https://github.com/nodejs/node/pull/32789 * (SEMVER-MINOR) return this from ClientRequest#destroy() (Colin Ihrig) https://github.com/nodejs/node/pull/32789 * (SEMVER-MINOR) return this from IncomingMessage#destroy() (Colin Ihrig) https://github.com/nodejs/node/pull/32789 * (SEMVER-MINOR) added scheduling option to http agent (delvedor) https://github.com/nodejs/node/pull/33278 http2: * (SEMVER-MINOR) return this for Http2ServerRequest#setTimeout (Pranshu Srivastava) https://github.com/nodejs/node/pull/33994 * (SEMVER-MINOR) do not modify explicity set date headers (Pranshu Srivastava) https://github.com/nodejs/node/pull/33160 process: * (SEMVER-MINOR) add unhandled-rejection throw and warn-with-error-code (Dan Fabulich) https://github.com/nodejs/node/pull/33475 src: * (SEMVER-MINOR) store key data in separate class (Tobias Nießen) https://github.com/nodejs/node/pull/33360 * (SEMVER-MINOR) add NativeKeyObject base class (Tobias Nießen) https://github.com/nodejs/node/pull/33360 * (SEMVER-MINOR) rename internal key handles to KeyObjectHandle (Tobias Nießen) https://github.com/nodejs/node/pull/33360 * (SEMVER-MINOR) add equality operators for BaseObjectPtr (Anna Henningsen) https://github.com/nodejs/node/pull/33772 * (SEMVER-MINOR) introduce BaseObject base FunctionTemplate (Anna Henningsen) https://github.com/nodejs/node/pull/33772 * (SEMVER-MINOR) add public APIs to manage v8::TracingController (Anna Henningsen) https://github.com/nodejs/node/pull/33850 stream*: * runtime deprecate Transform._transformState (Robert Nagy) https://github.com/nodejs/node/pull/32763 win: * (SEMVER-MINOR) allow skipping the supported platform check (João Reis) https://github.com/nodejs/node/pull/33176 worker: * (SEMVER-MINOR) add public method for marking objects as untransferable (Anna Henningsen) https://github.com/nodejs/node/pull/33979 * (SEMVER-MINOR) emit `'messagerror'` events for failed deserialization (Anna Henningsen) https://github.com/nodejs/node/pull/33772 * (SEMVER-MINOR) allow passing JS wrapper objects via postMessage (Anna Henningsen) https://github.com/nodejs/node/pull/33772 * (SEMVER-MINOR) allow transferring/cloning generic BaseObjects (Anna Henningsen) https://github.com/nodejs/node/pull/33772 worker,fs: * (SEMVER-MINOR) make FileHandle transferable (Anna Henningsen) https://github.com/nodejs/node/pull/33772 zlib: * (SEMVER-MINOR) add `maxOutputLength` option (unknown) https://github.com/nodejs/node/pull/33516 PR-URL: https://github.com/nodejs/node/pull/34093
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/cli.md2
-rw-r--r--doc/api/crypto.md2
-rw-r--r--doc/api/deprecations.md6
-rw-r--r--doc/api/dgram.md2
-rw-r--r--doc/api/dns.md2
-rw-r--r--doc/api/errors.md2
-rw-r--r--doc/api/events.md64
-rw-r--r--doc/api/fs.md6
-rw-r--r--doc/api/http.md12
-rw-r--r--doc/api/http2.md6
-rw-r--r--doc/api/n-api.md2
-rw-r--r--doc/api/repl.md2
-rw-r--r--doc/api/worker_threads.md10
-rw-r--r--doc/api/zlib.md4
14 files changed, 61 insertions, 61 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md
index 8606054148e..33c1e94fafb 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1385,7 +1385,7 @@ Overriding this value to an empty string (`''`) will use the built-in REPL.
### `NODE_SKIP_PLATFORM_CHECK=value`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
If `value` equals `'1'`, the check for a supported platform is skipped during
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 49273db7608..0621ee62d32 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -1216,7 +1216,7 @@ This can be called many times with new data as it is streamed.
<!-- YAML
added: v11.6.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33360
description: Instances of this class can now be passed to worker threads
using `postMessage`.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 6875cc74345..62ea8787e2c 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -2722,9 +2722,9 @@ native modules. It was incomplete so far and instead it's better to rely upon
### DEP0143: `module.parent`
<!-- YAML
changes:
- - version: REPLACEME
- pr-url: https://github.com/nodejs/node/pull/32217
- description: Documentation-only deprecation.
+ - version: v14.5.0
+ pr-url: https://github.com/nodejs/node/pull/33126
+ description: Runtime deprecation.
-->
Type: Documentation-only (supports [`--pending-deprecation`][])
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
index e3c75e026c2..be0323a306b 100644
--- a/doc/api/dgram.md
+++ b/doc/api/dgram.md
@@ -399,7 +399,7 @@ if the socket is not connected.
<!-- YAML
added: v0.1.99
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/22413
description: The `msg` parameter can now be any `TypedArray` or `DataView`.
- version: v8.0.0
diff --git a/doc/api/dns.md b/doc/api/dns.md
index 6268d22b22e..5cd4046af39 100644
--- a/doc/api/dns.md
+++ b/doc/api/dns.md
@@ -96,7 +96,7 @@ The following methods from the `dns` module are available:
<!-- YAML
added: v8.3.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33472
description: The constructor now accepts an `options` object.
The single supported option is `timeout`.
diff --git a/doc/api/errors.md b/doc/api/errors.md
index 268e66cffbc..babff4810ea 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -1569,7 +1569,7 @@ failed.
<a id="ERR_MESSAGE_TARGET_CONTEXT_UNAVAILABLE"></a>
### `ERR_MESSAGE_TARGET_CONTEXT_UNAVAILABLE`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
A message posted to a [`MessagePort`][] could not be deserialized in the target
diff --git a/doc/api/events.md b/doc/api/events.md
index d008b95641e..39950b5c12f 100644
--- a/doc/api/events.md
+++ b/doc/api/events.md
@@ -939,7 +939,7 @@ composed of the emitted event arguments.
## `EventTarget` and `Event` API
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
> Stability: 1 - Experimental
@@ -1056,7 +1056,7 @@ The `EventTarget` does not implement any special default handling for
### Class: `Event`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
The `Event` object is an adaptation of the [`Event` Web API][]. Instances
@@ -1064,7 +1064,7 @@ are created internally by Node.js.
#### `event.bubbles`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {boolean} Always returns `false`.
@@ -1073,7 +1073,7 @@ This is not used in Node.js and is provided purely for completeness.
#### `event.cancelBubble()`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
Alias for `event.stopPropagation()`. This is not used in Node.js and is
@@ -1081,14 +1081,14 @@ provided purely for completeness.
#### `event.cancelable`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {boolean} True if the event was created with the `cancelable` option.
#### `event.composed`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {boolean} Always returns `false`.
@@ -1097,7 +1097,7 @@ This is not used in Node.js and is provided purely for completeness.
#### `event.composedPath()`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
Returns an array containing the current `EventTarget` as the only entry or
@@ -1106,7 +1106,7 @@ Node.js and is provided purely for completeness.
#### `event.currentTarget`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {EventTarget} The `EventTarget` dispatching the event.
@@ -1115,7 +1115,7 @@ Alias for `event.target`.
#### `event.defaultPrevented`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {boolean}
@@ -1125,7 +1125,7 @@ called.
#### `event.eventPhase`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {number} Returns `0` while an event is not being dispatched, `2` while
@@ -1135,7 +1135,7 @@ This is not used in Node.js and is provided purely for completeness.
#### `event.isTrusted`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {boolean} Always returns `false`.
@@ -1144,14 +1144,14 @@ This is not used in Node.js and is provided purely for completeness.
#### `event.preventDefault()`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
Sets the `defaultPrevented` property to `true` if `cancelable` is `true`.
#### `event.returnValue`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {boolean} True if the event has not been canceled.
@@ -1160,7 +1160,7 @@ This is not used in Node.js and is provided purely for completeness.
#### `event.srcElement`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {EventTarget} The `EventTarget` dispatching the event.
@@ -1169,28 +1169,28 @@ Alias for `event.target`.
#### `event.stopImmediatePropagation()`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
Stops the invocation of event listeners after the current one completes.
#### `event.stopPropagation()`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
This is not used in Node.js and is provided purely for completeness.
#### `event.target`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {EventTarget} The `EventTarget` dispatching the event.
#### `event.timeStamp`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {number}
@@ -1199,7 +1199,7 @@ The millisecond timestamp when the `Event` object was created.
#### `event.type`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Type: {string}
@@ -1208,12 +1208,12 @@ The event type identifier.
### Class: `EventTarget`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
#### `eventTarget.addEventListener(type, listener[, options])`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1255,7 +1255,7 @@ target.removeEventListener('foo', handler, { capture: true });
#### `eventTarget.dispatchEvent(event)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `event` {Object|Event}
@@ -1269,7 +1269,7 @@ were registered.
#### `eventTarget.removeEventListener(type, listener)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1281,7 +1281,7 @@ Removes the `listener` from the list of handlers for event `type`.
### Class: `NodeEventTarget`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Extends: {EventTarget}
@@ -1291,7 +1291,7 @@ that emulates a subset of the `EventEmitter` API.
#### `nodeEventTarget.addListener(type, listener[, options])`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1308,7 +1308,7 @@ equivalent `EventEmitter` API. The only difference between `addListener()` and
#### `nodeEventTarget.eventNames()`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* Returns: {string[]}
@@ -1318,7 +1318,7 @@ of event `type` names for which event listeners are registered.
#### `nodeEventTarget.listenerCount(type)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1330,7 +1330,7 @@ of event listeners registered for the `type`.
#### `nodeEventTarget.off(type, listener)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1342,7 +1342,7 @@ Node.js-speciic alias for `eventTarget.removeListener()`.
#### `nodeEventTarget.on(type, listener[, options])`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1356,7 +1356,7 @@ Node.js-specific alias for `eventTarget.addListener()`.
#### `nodeEventTarget.once(type, listener[, options])`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1371,7 +1371,7 @@ with the `once` option set to `true`.
#### `nodeEventTarget.removeAllListeners([type])`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
@@ -1382,7 +1382,7 @@ listeners.
#### `nodeEventTarget.removeListener(type, listener)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `type` {string}
diff --git a/doc/api/fs.md b/doc/api/fs.md
index dc6b11f2593..6ce2fded375 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -2400,7 +2400,7 @@ Synchronous lchown(2). Returns `undefined`.
## `fs.lutimes(path, atime, mtime, callback)`
<!-- YAML
-addded: REPLACEME
+addded: v14.5.0
-->
* `path` {string|Buffer|URL}
@@ -2419,7 +2419,7 @@ callback.
## `fs.lutimesSync(path, atime, mtime)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `path` {string|Buffer|URL}
@@ -5071,7 +5071,7 @@ no arguments upon success.
### `fsPromises.lutimes(path, atime, mtime)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `path` {string|Buffer|URL}
diff --git a/doc/api/http.md b/doc/api/http.md
index f6447ed35a3..5429bdb297c 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.5.0
pr-url: https://github.com/nodejs/node/pull/33278
description: Add `scheduling` option to specify the free socket
scheduling strategy.
@@ -304,7 +304,7 @@ can have open per origin. Origin is the returned value of [`agent.getName()`][].
### `agent.maxTotalSockets`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* {number}
@@ -660,7 +660,7 @@ is finished.
<!-- YAML
added: v0.3.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/32789
description: The function returns `this` for consistency with other Readable
streams.
@@ -765,14 +765,14 @@ added: v0.1.97
### `request.host`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* {string} The request host.
### `request.protocol`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* {string} The request protocol.
@@ -1917,7 +1917,7 @@ const req = http.request({
<!-- YAML
added: v0.3.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/32789
description: The function returns `this` for consistency with other Readable
streams.
diff --git a/doc/api/http2.md b/doc/api/http2.md
index 7798dc5d74e..168fded961b 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -1412,7 +1412,7 @@ and will throw an error.
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33160
description: Allow explicity setting date headers.
-->
@@ -1459,7 +1459,7 @@ server.on('stream', (stream) => {
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33160
description: Allow explicity setting date headers.
- version: v12.12.0
@@ -1560,7 +1560,7 @@ server.on('stream', (stream) => {
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33160
description: Allow explicity setting date headers.
- version: v10.0.0
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index a621d38e49b..a1a0b1abd28 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -5304,7 +5304,7 @@ This API may be called from any thread which makes use of `func`.
added: v10.6.0
napiVersion: 4
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33453
description: >
Support for `napi_would_deadlock` has been reverted.
diff --git a/doc/api/repl.md b/doc/api/repl.md
index bf0727e4771..9c12d8e8c67 100644
--- a/doc/api/repl.md
+++ b/doc/api/repl.md
@@ -546,7 +546,7 @@ with REPL instances programmatically.
## `repl.builtinModules`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* {string[]}
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
index a582332eaed..38167bfd0bf 100644
--- a/doc/api/worker_threads.md
+++ b/doc/api/worker_threads.md
@@ -84,7 +84,7 @@ if (isMainThread) {
## `worker.markAsUntransferable(object)`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
Mark an object as not transferable. If `object` occurs in the transfer list of
@@ -343,7 +343,7 @@ to `postMessage()` and no further arguments.
### Event: `'messageerror'`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `error` {Error} An Error object
@@ -366,10 +366,10 @@ are part of the channel.
<!-- YAML
added: v10.5.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33360
description: Added `KeyObject` to the list of cloneable types.
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33772
description: Added `FileHandle` to the list of transferable types.
-->
@@ -736,7 +736,7 @@ All messages sent from the worker thread will be emitted before the
### Event: `'messageerror'`
<!-- YAML
-added: REPLACEME
+added: v14.5.0
-->
* `error` {Error} An Error object
diff --git a/doc/api/zlib.md b/doc/api/zlib.md
index a64ae57c7bc..34adda9788d 100644
--- a/doc/api/zlib.md
+++ b/doc/api/zlib.md
@@ -488,7 +488,7 @@ These advanced options are available for controlling decompression:
<!-- YAML
added: v0.11.1
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33516
description: The `maxOutputLength` option is supported now.
- version: v9.4.0
@@ -529,7 +529,7 @@ information.
<!-- YAML
added: v11.7.0
changes:
- - version: REPLACEME
+ - version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33516
description: The `maxOutputLength` option is supported now.
-->