summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-03-02 09:53:46 -0800
committerJames M Snell <jasnell@gmail.com>2018-04-24 12:02:31 -0700
commit0cca27b3ffb9fade34aac0ee77d020fb7cac0879 (patch)
tree17817c8e1fafc9aeff2fec413c85c17d2a50fd3a /doc/api
parent7424d865236541226c0943866ad7e94c5191a763 (diff)
downloadandroid-node-v8-0cca27b3ffb9fade34aac0ee77d020fb7cac0879.tar.gz
android-node-v8-0cca27b3ffb9fade34aac0ee77d020fb7cac0879.tar.bz2
android-node-v8-0cca27b3ffb9fade34aac0ee77d020fb7cac0879.zip
2018-04-24, Version 10.0.0 (Current)
* Assert * Calling `assert.fail()` with more than one argument is deprecated. #70dcacd710 * Calling `assert.ok()` with no arguments will now throw. #3cd7977a42 * Calling `assert.ifError()` will now throw with any argument other than `undefined` or `null`. Previously the method would throw with any truthy value. #e65a6e81ef * The `assert.rejects()` and `assert.doesNotReject()` methods have been added for working with async functions. #599337f43e * Async_hooks * Older experimental async_hooks APIs have been removed. #1cc6b993b9 * Buffer * Uses of `new Buffer()` and `Buffer()` outside of the `node_modules` directory will now emit a runtime deprecation warning. #9d4ab90117 * `Buffer.isEncoding()` now returns `undefined` for falsy values, including an empty string. #452eed956e * `Buffer.fill()` will throw if an attempt is made to fill with an empty `Buffer`. #1e802539b2 * Child Process * Undefined properties of env are ignored. #38ee25e2e2, #85739b6c5b * Console * The `console.table()` method has been added. #97ace04492 * Crypto * The `crypto.createCipher()` and `crypto.createDecipher()` methods have been deprecated. Please use `crypto.createCipheriv()` and `crypto.createDecipheriv()` instead. #81f88e30dd * The `decipher.finaltol()` method has been deprecated. #19f3927d92 * The `crypto.DEFAULT_ENCODING` property has been deprecated. #6035beea93 * The `ECDH.convertKey()` method has been added. #f2e02883e7 * The `crypto.fips` property has been deprecated. #6e7992e8b8 * Dependencies * V8 has been updated to 6.6. #9daebb48d6 * OpenSSL has been updated to 1.1.0h. #66cb29e646 * EventEmitter * The `EventEmitter.prototype.off()` method has been added as an alias for `EventEmitter.prototype.removeListener()`. #3bb6f07d52 * File System * The `fs.promises` API provides experimental promisified versions of the `fs` functions. #329fc78e49 * Invalid path errors are now thrown synchronously. #d8f73385e2 * The `fs.readFile()` method now partitions reads to avoid thread pool exhaustion. #67a4ce1c6e * HTTP * Processing of HTTP Status codes `100`, `102-199` has been improved. #baf8495078 * Multi-byte characters in URL paths are now forbidden. #b961d9fd83 * N-API * The n-api is no longer experimental. #cd7d7b15c1 * Net * The `'close'` event will be emitted after `'end'`. #9b7a6914a7 * Perf_hooks * The `PerformanceObserver` class is now an `AsyncResource` and can be monitored using `async_hooks`. #009e41826f * Trace events are now emitted for performance events. #9e509b622b * The `performance` API has been simplified. #2ec6995555 * Performance milestone marks will be emitted as trace events. #96cb4fb795 * Process * Using non-string values for `process.env` is deprecated. #5826fe4e79 * The `process.assert()` method is deprecated. #703e37cf3f * REPL * REPL now experimentally supports top-level await when using the `--experimental-repl-await` flag. #eeab7bc068 * The previously deprecated "magic mode" has been removed. #4893f70d12 * The previously deprecated `NODE_REPL_HISTORY_FILE` environment variable has been removed. #60c9ad7979 * Proxy objects are shown as Proxy objects when inspected. #90a43906ab * Streams * The `'readable'` event is now always deferred with nextTick. #1e0f3315c7 * A new `pipeline()` method has been provided for building end-to-data stream pipelines. #a5cf3feaf1 * Experimental support for async for-await has been added to `stream.Readable`. #61b4d60c5d * Timers * The `enroll()` and `unenroll()` methods have been deprecated. #68783ae0b8 * TLS * The `tls.convertNONProtocols()` method has been deprecated. #9204a0db6e * Support for NPN (next protocol negotiation) has been dropped. #5bfbe5ceae * The `ecdhCurve` default is now `'auto'`. #af78840b19 * Trace Events * A new `trace_events` top-level module allows trace event categories to be enabled/disabld at runtime. #da5d818a54 * URL * The WHATWG URL API is now a global. #312414662b * Util * `util.types.is[…]` type checks have been added. #b20af8088a * Support for bigint formatting has been added to `util.inspect()`. #39dc947409
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/assert.md16
-rw-r--r--doc/api/buffer.md60
-rw-r--r--doc/api/cli.md4
-rw-r--r--doc/api/console.md6
-rw-r--r--doc/api/crypto.md16
-rw-r--r--doc/api/deprecations.md4
-rw-r--r--doc/api/fs.md158
-rw-r--r--doc/api/globals.md4
-rw-r--r--doc/api/http.md12
-rw-r--r--doc/api/http2.md12
-rw-r--r--doc/api/process.md2
-rw-r--r--doc/api/repl.md4
-rw-r--r--doc/api/stream.md18
-rw-r--r--doc/api/tracing.md16
-rw-r--r--doc/api/url.md4
-rw-r--r--doc/api/util.md78
-rw-r--r--doc/api/vm.md6
-rw-r--r--doc/api/zlib.md4
18 files changed, 212 insertions, 212 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md
index 62c96801d3..ab4aa9c7cd 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -376,7 +376,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
## assert.doesNotReject(block[, error][, message])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `block` {Function|Promise}
* `error` {RegExp|Function}
@@ -565,7 +565,7 @@ See below for further details.
<!-- YAML
added: v0.1.21
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18418
description: Calling `assert.fail()` with more than one argument is
deprecated and emits a warning.
@@ -627,11 +627,11 @@ suppressFrame();
<!-- YAML
added: v0.1.97
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18247
description: Instead of throwing the original error it is now wrapped into
a AssertionError that contains the full stack trace.
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18247
description: Value may now only be `undefined` or `null`. Before any truthy
input was accepted.
@@ -816,7 +816,7 @@ instance of an [`Error`][] then it will be thrown instead of the
<!-- YAML
added: v0.1.21
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17003
description: Used comparison changed from Strict Equality to `Object.is()`
-->
@@ -850,7 +850,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
<!-- YAML
added: v0.1.21
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18319
description: assert.ok() (no arguments) will now use a predefined error msg.
-->
@@ -920,7 +920,7 @@ assert(0);
## assert.rejects(block[, error][, message])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `block` {Function|Promise}
* `error` {RegExp|Function|Object|Error}
@@ -980,7 +980,7 @@ argument gets considered.
<!-- YAML
added: v0.1.21
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17003
description: Used comparison changed from Strict Equality to `Object.is()`
-->
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 6e6a4f77f5..0195c1cd26 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -302,7 +302,7 @@ It can be constructed in a variety of ways.
<!-- YAML
deprecated: v6.0.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19524
description: Calling this constructor emits a deprecation warning when
run from code outside the `node_modules` directory.
@@ -330,7 +330,7 @@ const buf = new Buffer([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
added: v3.0.0
deprecated: v6.0.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19524
description: Calling this constructor emits a deprecation warning when
run from code outside the `node_modules` directory.
@@ -386,7 +386,7 @@ console.log(buf);
<!-- YAML
deprecated: v6.0.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19524
description: Calling this constructor emits a deprecation warning when
run from code outside the `node_modules` directory.
@@ -421,7 +421,7 @@ console.log(buf2.toString());
<!-- YAML
deprecated: v6.0.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19524
description: Calling this constructor emits a deprecation warning when
run from code outside the `node_modules` directory.
@@ -462,7 +462,7 @@ console.log(buf);
<!-- YAML
deprecated: v6.0.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19524
description: Calling this constructor emits a deprecation warning when
run from code outside the `node_modules` directory.
@@ -499,11 +499,11 @@ console.log(buf1.toString('ascii'));
<!-- YAML
added: v5.10.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18129
description: Attempting to fill a non-zero length buffer with a zero length
buffer triggers a thrown exception.
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17427
description: Specifying an invalid string for `fill` triggers a thrown
exception.
@@ -1171,14 +1171,14 @@ console.log(buf1.equals(buf3));
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18790
description: Negative `end` values throw an `ERR_INDEX_OUT_OF_RANGE` error.
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18129
description: Attempting to fill a non-zero length buffer with a zero length
buffer triggers a thrown exception.
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17427
description: Specifying an invalid string for `value` triggers a thrown
exception.
@@ -1505,7 +1505,7 @@ The `buf.parent` property is a deprecated alias for `buf.buffer`.
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1535,7 +1535,7 @@ console.log(buf.readDoubleLE(1));
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1564,7 +1564,7 @@ console.log(buf.readFloatLE(1));
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1594,7 +1594,7 @@ console.log(buf.readInt8(2));
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1626,7 +1626,7 @@ console.log(buf.readInt16LE(1));
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1658,7 +1658,7 @@ console.log(buf.readInt32LE(1));
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset and
byteLength to uint32 anymore.
@@ -1691,7 +1691,7 @@ console.log(buf.readIntBE(1, 0).toString(16));
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1719,7 +1719,7 @@ console.log(buf.readUInt8(2));
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1753,7 +1753,7 @@ console.log(buf.readUInt16LE(2).toString(16));
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -1783,7 +1783,7 @@ console.log(buf.readUInt32LE(1).toString(16));
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset and
byteLength to uint32 anymore.
@@ -2100,7 +2100,7 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2135,7 +2135,7 @@ console.log(buf);
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2169,7 +2169,7 @@ console.log(buf);
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2201,7 +2201,7 @@ console.log(buf);
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2234,7 +2234,7 @@ console.log(buf);
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2267,7 +2267,7 @@ console.log(buf);
<!-- YAML
added: v0.11.15
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset and
byteLength to uint32 anymore.
@@ -2302,7 +2302,7 @@ console.log(buf);
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2334,7 +2334,7 @@ console.log(buf);
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2371,7 +2371,7 @@ console.log(buf);
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset to
uint32 anymore.
@@ -2406,7 +2406,7 @@ console.log(buf);
<!-- YAML
added: v0.5.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18395
description: Removed noAssert and no implicit coercion of the offset and
byteLength to uint32 anymore.
diff --git a/doc/api/cli.md b/doc/api/cli.md
index 97edf0f4b2..164e370fff 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -76,7 +76,7 @@ Enable experimental ES module support and caching modules.
### `--experimental-repl-await`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
Enable experimental top-level `await` keyword support in REPL.
@@ -397,7 +397,7 @@ added:
- v5.0.0
- v4.2.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19600
description: The `--require` option is now supported when checking a file.
-->
diff --git a/doc/api/console.md b/doc/api/console.md
index 28dd0b854b..825ca28e28 100644
--- a/doc/api/console.md
+++ b/doc/api/console.md
@@ -85,7 +85,7 @@ changes:
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/9744
description: The `ignoreErrors` option was introduced.
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19372
description: The `Console` constructor now supports an `options` argument,
and the `colorMode` option was introduced.
@@ -128,7 +128,7 @@ new Console({ stdout: process.stdout, stderr: process.stderr });
<!-- YAML
added: v0.1.101
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17706
description: The implementation is now spec compliant and does not throw
anymore.
@@ -347,7 +347,7 @@ See [`util.format()`][] for more information.
### console.table(tabularData[, properties])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `tabularData` {any}
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 47181f6a2c..ae121e83f2 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -674,7 +674,7 @@ assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
### ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
- `key` {string | Buffer | TypedArray | DataView}
@@ -728,7 +728,7 @@ changes:
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/5522
description: The default `inputEncoding` changed from `binary` to `utf8`
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/16849
description: Changed error format to better support invalid public key
error
@@ -1291,7 +1291,7 @@ added: v6.3.0
### crypto.DEFAULT_ENCODING
<!-- YAML
added: v0.9.3
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
The default encoding to use for functions that can take either strings
@@ -1308,7 +1308,7 @@ This property is deprecated.
### crypto.fips
<!-- YAML
added: v6.0.0
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
Property for checking and controlling whether a FIPS compliant crypto provider
@@ -1320,7 +1320,7 @@ This property is deprecated. Please use `crypto.setFips()` and
### crypto.createCipher(algorithm, password[, options])
<!-- YAML
added: v0.1.94
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
> Stability: 0 - Deprecated: Use [`crypto.createCipheriv()`][] instead.
@@ -1423,7 +1423,7 @@ called.
### crypto.createDecipher(algorithm, password[, options])
<!-- YAML
added: v0.1.94
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
> Stability: 0 - Deprecated: Use [`crypto.createDecipheriv()`][] instead.
@@ -1724,7 +1724,7 @@ console.log(aliceSecret === bobSecret);
### crypto.getFips()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
- Returns: {boolean} `true` if and only if a FIPS compliant crypto provider is
currently in use.
@@ -2158,7 +2158,7 @@ The flags below are deprecated in OpenSSL-1.1.0.
### crypto.setFips(bool)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `bool` {boolean} `true` to enable FIPS mode.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 6689f03a25..1c3c488c8d 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -94,7 +94,7 @@ is strongly recommended:
* [`Buffer.from(string[, encoding])`][from_string_encoding] - Create a `Buffer`
that copies `string`.
-As of REPLACEME, a deprecation warning is printed at runtime when
+As of v10.0.0, a deprecation warning is printed at runtime when
`--pending-deprecation` is used or when the calling code is
outside `node_modules` in order to better target developers, rather than users.
@@ -170,7 +170,7 @@ explicitly via error event handlers set on the domain instead.
Type: End-of-Life
Calling an asynchronous function without a callback throws a `TypeError`
-REPLACEME onwards. Refer: [PR 12562](https://github.com/nodejs/node/pull/12562)
+v10.0.0 onwards. Refer: [PR 12562](https://github.com/nodejs/node/pull/12562)
<a id="DEP0014"></a>
### DEP0014: fs.read legacy String interface
diff --git a/doc/api/fs.md b/doc/api/fs.md
index a80a5efcb4..d585164faf 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -322,7 +322,7 @@ fs.watch('./tmp', { encoding: 'buffer' }, (eventType, filename) => {
### Event: 'close'
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
Emitted when the watcher stops watching for changes.
@@ -896,7 +896,7 @@ try {
<!-- YAML
added: v0.6.7
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1016,7 +1016,7 @@ try {
<!-- YAML
added: v0.1.30
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1103,7 +1103,7 @@ See also: chmod(2)
<!-- YAML
added: v0.1.97
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1151,7 +1151,7 @@ See also: chown(2)
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1532,7 +1532,7 @@ a callback.)
<!-- YAML
added: v0.4.7
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1564,7 +1564,7 @@ Synchronous fchmod(2). Returns `undefined`.
<!-- YAML
added: v0.4.7
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1598,7 +1598,7 @@ Synchronous fchown(2). Returns `undefined`.
<!-- YAML
added: v0.1.96
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1628,7 +1628,7 @@ Synchronous fdatasync(2). Returns `undefined`.
<!-- YAML
added: v0.1.95
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1661,7 +1661,7 @@ Synchronous fstat(2).
<!-- YAML
added: v0.1.96
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1691,7 +1691,7 @@ Synchronous fsync(2). Returns `undefined`.
<!-- YAML
added: v0.8.6
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1764,7 +1764,7 @@ Synchronous ftruncate(2). Returns `undefined`.
<!-- YAML
added: v0.4.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1810,7 +1810,7 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
<!-- YAML
deprecated: v0.4.7
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1844,7 +1844,7 @@ Synchronous lchmod(2). Returns `undefined`.
<!-- YAML
deprecated: v0.4.7
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1878,7 +1878,7 @@ Synchronous lchown(2). Returns `undefined`.
<!-- YAML
added: v0.1.31
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1921,7 +1921,7 @@ Synchronous link(2). Returns `undefined`.
<!-- YAML
added: v0.1.30
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -1964,7 +1964,7 @@ Synchronous lstat(2).
<!-- YAML
added: v0.1.8
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2010,7 +2010,7 @@ See also: mkdir(2)
<!-- YAML
added: v5.10.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2195,7 +2195,7 @@ a Promise for an object with `bytesRead` and `buffer` properties.
<!-- YAML
added: v0.1.8
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2254,7 +2254,7 @@ the filenames returned will be passed as `Buffer` objects.
<!-- YAML
added: v0.1.29
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2368,7 +2368,7 @@ fs.readFileSync('<directory>'); // => null, <data>
<!-- YAML
added: v0.1.31
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2441,7 +2441,7 @@ Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
<!-- YAML
added: v0.1.31
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2598,7 +2598,7 @@ this restriction.
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2652,7 +2652,7 @@ Synchronous rename(2). Returns `undefined`.
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2697,7 +2697,7 @@ on Windows and an `ENOTDIR` error on POSIX.
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2797,7 +2797,7 @@ Synchronous symlink(2). Returns `undefined`.
<!-- YAML
added: v0.8.6
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2837,7 +2837,7 @@ in the future.
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -2909,7 +2909,7 @@ and `fs.unwatchFile()` when possible.
<!-- YAML
added: v0.4.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -3146,7 +3146,7 @@ This happens when:
<!-- YAML
added: v0.0.2
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -3199,7 +3199,7 @@ the end of the file.
<!-- YAML
added: v0.11.5
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -3250,7 +3250,7 @@ the end of the file.
<!-- YAML
added: v0.1.29
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
it will throw a `TypeError` at runtime.
@@ -3371,7 +3371,7 @@ API is accessible via `require('fs/promises')`.
### class: FileHandle
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
A `FileHandle` object is a wrapper for a numeric file descriptor.
@@ -3391,7 +3391,7 @@ unclosed file descriptors after a `Promise` is resolved or rejected.
#### filehandle.appendFile(data, options)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `data` {string|Buffer}
* `options` {Object|string}
@@ -3410,7 +3410,7 @@ The `FileHandle` must have been opened for appending.
#### filehandle.chmod(mode)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `mode` {integer}
* Returns: {Promise}
@@ -3420,7 +3420,7 @@ arguments upon success.
#### filehandle.chown(uid, gid)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `uid` {integer}
* `gid` {integer}
@@ -3431,7 +3431,7 @@ upon success.
#### filehandle.close()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {Promise} A `Promise` that will be resolved once the underlying
@@ -3454,7 +3454,7 @@ async function openAndClose() {
#### filehandle.datasync()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {Promise}
@@ -3463,14 +3463,14 @@ success.
#### filehandle.fd
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* {number} The numeric file descriptor managed by the `FileHandle` object.
#### filehandle.read(buffer, offset, length, position)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `buffer` {Buffer|Uint8Array}
* `offset` {integer}
@@ -3497,7 +3497,7 @@ property that is a reference to the passed in `buffer` argument.
#### filehandle.readFile(options)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `options` {Object|string}
* `encoding` {string|null} **Default:** `null`
@@ -3521,7 +3521,7 @@ The `FileHandle` has to support reading.
#### filehandle.stat()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {Promise}
@@ -3529,7 +3529,7 @@ Retrieves the [`fs.Stats`][] for the file.
#### filehandle.sync()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {Promise}
@@ -3538,7 +3538,7 @@ success.
#### filehandle.truncate(len)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `len` {integer} **Default:** `0`
* Returns: {Promise}
@@ -3584,7 +3584,7 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation.
#### filehandle.utimes(atime, mtime)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `atime` {number|string|Date}
* `mtime` {number|string|Date}`
@@ -3598,7 +3598,7 @@ This function does not work on AIX versions before 7.1, it will resolve the
#### filehandle.write(buffer, offset, length, position)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `buffer` {Buffer|Uint8Array}
* `offset` {integer}
@@ -3629,7 +3629,7 @@ the end of the file.
#### filehandle.writeFile(data, options)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `data` {string|Buffer|Uint8Array}
* `options` {Object|string}
@@ -3653,7 +3653,7 @@ without waiting for the `Promise` to be resolved (or rejected).
### fsPromises.access(path[, mode])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3693,7 +3693,7 @@ the error raised if the file is not accessible.
### fsPromises.appendFile(file, data[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
@@ -3715,7 +3715,7 @@ for appending (using `fsPromises.open()`).
### fsPromises.chmod(path, mode)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3727,7 +3727,7 @@ arguments upon succces.
### fsPromises.chown(path, uid, gid)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3740,7 +3740,7 @@ upon success.
### fsPromises.copyFile(src, dest[, flags])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `src` {string|Buffer|URL} source filename to copy
@@ -3795,7 +3795,7 @@ fsPromises.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL)
### fsPromises.fchmod(filehandle, mode)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3807,7 +3807,7 @@ success.
### fsPromises.fchown(filehandle, uid, gid)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3820,7 +3820,7 @@ the `Promise` with no arguments upon success.
### fsPromises.fdatasync(filehandle)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3831,7 +3831,7 @@ success.
### fsPromises.fstat(filehandle)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3841,7 +3841,7 @@ Retrieves the [`fs.Stats`][] for the given `filehandle`.
### fsPromises.fsync(filehandle)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3852,7 +3852,7 @@ success.
### fsPromises.ftruncate(filehandle[, len])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3901,7 +3901,7 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation.
### fsPromises.futimes(filehandle, atime, mtime)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -3917,7 +3917,7 @@ This function does not work on AIX versions before 7.1, it will resolve the
### fsPromises.lchmod(path, mode)
<!-- YAML
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3929,7 +3929,7 @@ no arguments upon success. This method is only implemented on macOS.
### fsPromises.lchown(path, uid, gid)
<!-- YAML
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3942,7 +3942,7 @@ no arguments upon success. This method is only implemented on macOS.
### fsPromises.link(existingPath, newPath)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `existingPath` {string|Buffer|URL}
@@ -3953,7 +3953,7 @@ Asynchronous link(2). The `Promise` is resolved with no arguments upon success.
### fsPromises.lstat(path)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3964,7 +3964,7 @@ for the given symbolic link `path`.
### fsPromises.mkdir(path[, mode])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -3976,7 +3976,7 @@ arguments upon success.
### fsPromises.mkdtemp(prefix[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `prefix` {string}
@@ -4006,7 +4006,7 @@ intention is to create a temporary directory *within* `/tmp`, the `prefix`
### fsPromises.open(path, flags[, mode])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4027,7 +4027,7 @@ a colon, Node.js will open a file system stream, as described by
### fsPromises.read(filehandle, buffer, offset, length, position)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -4056,7 +4056,7 @@ property that is a reference to the passed in `buffer` argument.
### fsPromises.readdir(path[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4074,7 +4074,7 @@ will be passed as `Buffer` objects.
### fsPromises.readFile(path[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL|FileHandle} filename or `FileHandle`
@@ -4100,7 +4100,7 @@ Any specified `FileHandle` has to support reading.
### fsPromises.readlink(path[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4118,7 +4118,7 @@ returned will be passed as a `Buffer` object.
### fsPromises.realpath(path[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4143,7 +4143,7 @@ this restriction.
### fsPromises.rename(oldPath, newPath)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `oldPath` {string|Buffer|URL}
@@ -4155,7 +4155,7 @@ upon success.
### fsPromises.rmdir(path)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4170,7 +4170,7 @@ error on POSIX.
### fsPromises.stat(path)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4180,7 +4180,7 @@ The `Promise` is resolved with the [`fs.Stats`][] object for the given `path`.
### fsPromises.symlink(target, path[, type])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `target` {string|Buffer|URL}
@@ -4198,7 +4198,7 @@ the `target` argument will automatically be normalized to absolute path.
### fsPromises.truncate(path[, len])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4210,7 +4210,7 @@ success. The `path` *must* be a string or `Buffer`.
### fsPromises.unlink(path)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4221,7 +4221,7 @@ success.
### fsPromises.utimes(path, atime, mtime)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `path` {string|Buffer|URL}
@@ -4240,7 +4240,7 @@ The `atime` and `mtime` arguments follow these rules:
### fsPromises.write(filehandle, buffer[, offset[, length[, position]]])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `filehandle` {FileHandle}
@@ -4273,7 +4273,7 @@ the end of the file.
### fsPromises.writeFile(file, data[, options])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
diff --git a/doc/api/globals.md b/doc/api/globals.md
index 9ed63764d3..a9aaefeefa 100644
--- a/doc/api/globals.md
+++ b/doc/api/globals.md
@@ -140,7 +140,7 @@ added: v0.0.1
## URL
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
<!-- type=global -->
@@ -149,7 +149,7 @@ The WHATWG `URL` class. See the [`URL`][] section.
## URLSearchParams
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
<!-- type=global -->
diff --git a/doc/api/http.md b/doc/api/http.md
index 700dce3b94..d6f738cb81 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -403,7 +403,7 @@ the client should send the request body.
### Event: 'information'
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
Emitted when the server sends a 1xx response (excluding 101 Upgrade). This
@@ -547,7 +547,7 @@ See [`request.socket`][]
<!-- YAML
added: v0.1.90
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18780
description: This method now returns a reference to `ClientRequest`.
-->
@@ -888,8 +888,8 @@ per connection (in the case of HTTP Keep-Alive connections).
<!-- YAML
added: v0.1.94
changes:
- - version: REPLACEME
- pr-url: REPLACEME
+ - version: v10.0.0
+ pr-url: v10.0.0
description: Not listening to this event no longer causes the socket
to be destroyed if a client sends an Upgrade header.
-->
@@ -1068,7 +1068,7 @@ See [`response.socket`][].
<!-- YAML
added: v0.1.90
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18780
description: This method now returns a reference to `ServerResponse`.
-->
@@ -1459,7 +1459,7 @@ will result in a [`TypeError`][] being thrown.
### response.writeProcessing()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
Sends a HTTP/1.1 102 Processing message to the client, indicating that
diff --git a/doc/api/http2.md b/doc/api/http2.md
index f35e9b8b29..dd53e9f27f 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -328,7 +328,7 @@ Will be `true` if this `Http2Session` instance has been closed, otherwise
#### http2session.connecting
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* {boolean}
@@ -883,7 +883,7 @@ stream.on('trailers', (headers, flags) => {
#### Event: 'wantTrailers'
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
The `'wantTrailers'` event is emitted when the `Http2Stream` has queued the
@@ -1055,7 +1055,7 @@ A current state of this `Http2Stream`.
#### http2stream.sendTrailers(headers)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `headers` {HTTP/2 Headers Object}
@@ -1284,7 +1284,7 @@ server.on('stream', (stream) => {
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18936
description: Any readable file descriptor, not necessarily for a
regular file, is supported now.
@@ -1379,7 +1379,7 @@ server.on('stream', (stream) => {
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18936
description: Any readable file, not necessarily a
regular file, is supported now.
@@ -2715,7 +2715,7 @@ See [`response.socket`][].
<!-- YAML
added: v8.4.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18780
description: This method now returns a reference to `ServerResponse`.
-->
diff --git a/doc/api/process.md b/doc/api/process.md
index 202725cb51..bc8c100002 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -840,7 +840,7 @@ emitMyWarning();
<!-- YAML
added: v0.1.27
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18990
description: Implicit conversion of variable value to string is deprecated.
-->
diff --git a/doc/api/repl.md b/doc/api/repl.md
index 46cac0df3e..2231232827 100644
--- a/doc/api/repl.md
+++ b/doc/api/repl.md
@@ -441,8 +441,8 @@ Returns `true` if `keyword` is a valid keyword, otherwise `false`.
<!-- YAML
added: v0.1.91
changes:
- - version: REPLACEME
- pr-url: https://github.com/nodejs/node/pull/REPLACEME
+ - version: v10.0.0
+ pr-url: https://github.com/nodejs/node/pull/v10.0.0
description: The `REPL_MAGIC_MODE` replMode was removed.
- version: v5.8.0
pr-url: https://github.com/nodejs/node/pull/5388
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 705b58a31c..23de6a31ef 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -374,7 +374,7 @@ but instead implement [`writable._destroy()`][writable-_destroy].
<!-- YAML
added: v0.9.4
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18780
description: This method now returns a reference to `writable`.
- version: v8.0.0
@@ -763,12 +763,12 @@ The listener callback will be passed a single `Error` object.
<!-- YAML
added: v0.9.4
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17979
description: >
The `'readable'` is always emitted in the next tick after `.push()`
is called
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18994
description: Using `'readable'` requires calling `.read()`.
-->
@@ -1017,7 +1017,7 @@ the status of the `highWaterMark`.
<!-- YAML
added: v0.9.4
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18994
description: The `resume()` has no effect if there is a `'readable'` event
listening.
@@ -1211,7 +1211,7 @@ myReader.on('readable', () => {
##### readable\[Symbol.asyncIterator\]()
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
> Stability: 1 - Experimental
@@ -1292,7 +1292,7 @@ The default implementation of `_destroy()` for `Transform` also emit `'close'`.
### stream.finished(stream, callback)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `stream` {Stream} A readable and/or writable stream.
@@ -1340,7 +1340,7 @@ rs.resume(); // drain the stream
### stream.pipeline(...streams[, callback])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `...streams` {Stream} Two or more streams to pipe between.
@@ -1525,7 +1525,7 @@ constructor and implement the `writable._write()` method. The
#### Constructor: new stream.Writable([options])
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18438
description: >
Add `emitClose` option to specify if `'close'` is emitted on destroy
@@ -1845,7 +1845,7 @@ const myReadable = new Readable({
<!-- YAML
added: v0.9.4
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17979
description: call _read() only once per microtick
-->
diff --git a/doc/api/tracing.md b/doc/api/tracing.md
index 0b46abf81b..f83e808dc8 100644
--- a/doc/api/tracing.md
+++ b/doc/api/tracing.md
@@ -76,12 +76,12 @@ unlike `process.hrtime()` which returns nanoseconds.
## The `trace_events` module
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
### `Tracing` object
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
The `Tracing` object is used to enable or disable tracing for sets of
@@ -95,7 +95,7 @@ set of enabled trace event categories.
#### `tracing.categories`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* {string}
@@ -105,7 +105,7 @@ A comma-separated list of the trace event categories covered by this
#### `tracing.disable()`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
Disables this `Tracing` object.
@@ -131,7 +131,7 @@ console.log(trace_events.getEnabledCategories());
#### `tracing.enable()`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
Enables this `Tracing` object for the set of categories covered by the
@@ -139,14 +139,14 @@ Enables this `Tracing` object for the set of categories covered by the
#### `tracing.enabled`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* {boolean} `true` only if the `Tracing` object has been enabled.
### `trace_events.createTracing(options)`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `options` {Object}
@@ -168,7 +168,7 @@ tracing.disable();
### `trace_events.getEnabledCategories()`
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {string}
diff --git a/doc/api/url.md b/doc/api/url.md
index 97cc284a6d..35a72da8ee 100644
--- a/doc/api/url.md
+++ b/doc/api/url.md
@@ -75,7 +75,7 @@ const myURL =
<!-- YAML
added: v7.0.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18281
description: The class is now available on the global object.
-->
@@ -477,7 +477,7 @@ console.log(JSON.stringify(myURLs));
<!-- YAML
added: v7.5.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/18281
description: The class is now available on the global object.
-->
diff --git a/doc/api/util.md b/doc/api/util.md
index e8f97397d3..8da80d1f79 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -120,7 +120,7 @@ environment variable: `NODE_DEBUG=fs,net,tls`.
<!-- YAML
added: v0.8.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/16393
description: Deprecation warnings are only emitted once for each code.
-->
@@ -256,7 +256,7 @@ with care and never in a hot code path.
## util.formatWithOptions(inspectOptions, format[, ...args])
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* `inspectOptions` {Object}
@@ -363,7 +363,7 @@ stream.write('With ES6');
<!-- YAML
added: v0.3.0
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19259
description: WeakMap and WeakSet entries can now be inspected as well.
- version: REPLACEME
@@ -938,7 +938,7 @@ The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`.
## util.types
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
`util.types` provides a number of type checks for different kinds of built-in
@@ -953,7 +953,7 @@ useful for addon developers who prefer to do type checking in JavaScript.
### util.types.isAnyArrayBuffer(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -973,7 +973,7 @@ util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
### util.types.isArgumentsObject(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -991,7 +991,7 @@ function foo() {
### util.types.isArrayBuffer(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1009,7 +1009,7 @@ util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
### util.types.isAsyncFunction(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1028,7 +1028,7 @@ util.types.isAsyncFunction(async function foo() {}); // Returns true
### util.types.isBooleanObject(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1049,7 +1049,7 @@ util.types.isBooleanObject(Boolean(true)); // Returns false
### util.types.isDataView(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1068,7 +1068,7 @@ See also [`ArrayBuffer.isView()`][].
### util.types.isDate(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1083,7 +1083,7 @@ util.types.isDate(new Date()); // Returns true
### util.types.isExternal(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1092,7 +1092,7 @@ Returns `true` if the value is a native `External` value.
### util.types.isFloat32Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1109,7 +1109,7 @@ util.types.isFloat32Array(new Float64Array()); // Returns false
### util.types.isFloat64Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1126,7 +1126,7 @@ util.types.isFloat64Array(new Float64Array()); // Returns true
### util.types.isGeneratorFunction(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1145,7 +1145,7 @@ util.types.isGeneratorFunction(function* foo() {}); // Returns true
### util.types.isGeneratorObject(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1166,7 +1166,7 @@ util.types.isGeneratorObject(generator); // Returns true
### util.types.isInt8Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1183,7 +1183,7 @@ util.types.isInt8Array(new Float64Array()); // Returns false
### util.types.isInt16Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1200,7 +1200,7 @@ util.types.isInt16Array(new Float64Array()); // Returns false
### util.types.isInt32Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1217,7 +1217,7 @@ util.types.isInt32Array(new Float64Array()); // Returns false
### util.types.isMap(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1232,7 +1232,7 @@ util.types.isMap(new Map()); // Returns true
### util.types.isMapIterator(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1252,7 +1252,7 @@ util.types.isMapIterator(map[Symbol.iterator]()); // Returns true
### util.types.isNativeError(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1269,7 +1269,7 @@ util.types.isNativeError(new RangeError()); // Returns true
### util.types.isNumberObject(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1286,7 +1286,7 @@ util.types.isNumberObject(new Number(0)); // Returns true
### util.types.isPromise(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1301,7 +1301,7 @@ util.types.isPromise(Promise.resolve(42)); // Returns true
### util.types.isProxy(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1319,7 +1319,7 @@ util.types.isProxy(proxy); // Returns true
### util.types.isRegExp(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1335,7 +1335,7 @@ util.types.isRegExp(new RegExp('abc')); // Returns true
### util.types.isSet(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1350,7 +1350,7 @@ util.types.isSet(new Set()); // Returns true
### util.types.isSetIterator(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1370,7 +1370,7 @@ util.types.isSetIterator(set[Symbol.iterator]()); // Returns true
### util.types.isSharedArrayBuffer(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1388,7 +1388,7 @@ util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
### util.types.isStringObject(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1405,7 +1405,7 @@ util.types.isStringObject(new String('foo')); // Returns true
### util.types.isSymbolObject(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1423,7 +1423,7 @@ util.types.isSymbolObject(Object(symbol)); // Returns true
### util.types.isTypedArray(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1442,7 +1442,7 @@ See also [`ArrayBuffer.isView()`][].
### util.types.isUint8Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1459,7 +1459,7 @@ util.types.isUint8Array(new Float64Array()); // Returns false
### util.types.isUint8ClampedArray(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1476,7 +1476,7 @@ util.types.isUint8ClampedArray(new Float64Array()); // Returns false
### util.types.isUint16Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1493,7 +1493,7 @@ util.types.isUint16Array(new Float64Array()); // Returns false
### util.types.isUint32Array(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1510,7 +1510,7 @@ util.types.isUint32Array(new Float64Array()); // Returns false
### util.types.isWeakMap(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1525,7 +1525,7 @@ util.types.isWeakMap(new WeakMap()); // Returns true
### util.types.isWeakSet(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
@@ -1540,7 +1540,7 @@ util.types.isWeakSet(new WeakSet()); // Returns true
### util.types.isWebAssemblyCompiledModule(value)
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* Returns: {boolean}
diff --git a/doc/api/vm.md b/doc/api/vm.md
index 6c7bdeffda..75fb03642c 100644
--- a/doc/api/vm.md
+++ b/doc/api/vm.md
@@ -510,7 +510,7 @@ overhead.
<!-- YAML
added: v0.3.1
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19016
description: The `contextCodeGeneration` option is supported now.
-->
@@ -616,10 +616,10 @@ console.log(globalVar);
<!-- YAML
added: v0.3.1
changes:
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19398
description: The `sandbox` option can no longer be a function.
- - version: REPLACEME
+ - version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19016
description: The `codeGeneration` option is supported now.
-->
diff --git a/doc/api/zlib.md b/doc/api/zlib.md
index 053cd2893a..1fe05f26ca 100644
--- a/doc/api/zlib.md
+++ b/doc/api/zlib.md
@@ -400,7 +400,7 @@ class of the compressor/decompressor classes.
### zlib.bytesRead
<!-- YAML
added: v8.1.0
-deprecated: REPLACEME
+deprecated: v10.0.0
-->
> Stability: 0 - Deprecated: Use [`zlib.bytesWritten`][] instead.
@@ -414,7 +414,7 @@ expose values under these names.
### zlib.bytesWritten
<!-- YAML
-added: REPLACEME
+added: v10.0.0
-->
* {number}