summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-10-02 16:01:19 -0700
committerJames M Snell <jasnell@gmail.com>2018-10-23 11:03:02 -0700
commit3516052bee118dce767dd330fa857f6615c5b28a (patch)
treec375e4202694cd3307963f444622e90df0467ae8 /doc/api
parent8a02d941b6c2e053376dd70dd0cca2351903c577 (diff)
downloadandroid-node-v8-3516052bee118dce767dd330fa857f6615c5b28a.tar.gz
android-node-v8-3516052bee118dce767dd330fa857f6615c5b28a.tar.bz2
android-node-v8-3516052bee118dce767dd330fa857f6615c5b28a.zip
2018-10-23, Version 11.0.0 (Current)
Notable changes: * Build * FreeBSD 10 is no longer supported.[#22617](https://github.com/nodejs/node/pull/22617) * `child_process` * The default value of the `windowsHide` option has been changed to `true`. [#21316](https://github.com/nodejs/node/pull/21316) * `console` * `console.countReset()` will emit a warning if the timer being reset does not exist. [#21649](https://github.com/nodejs/node/pull/21649) * `console.time()` will no longer reset a timer if it already exists. [#20442](https://github.com/nodejs/node/pull/20442) * Dependencies * V8 has been updated to 7.0. [#22754](https://github.com/nodejs/node/pull/22754) * `fs` * The `fs.read()` method now requires a callback. [#22146](https://github.com/nodejs/node/pull/22146) * The previously deprecated `fs.SyncWriteStream` utility has been removed.[#20735](https://github.com/nodejs/node/pull/20735) * `http` * The `http`, `https`, and `tls` modules now use the WHATWG URL parser by default. [#20270](https://github.com/nodejs/node/pull/20270) * General * Use of `process.binding()` has been deprecated. Userland code using `process.binding()` should re-evaluate that use and begin migrating. If there are no supported API alternatives, please open an issue in the Node.js GitHub repository so that a suitable alternative may be discussed. * An experimental implementation of `queueMicrotask()` has been added. [#22951](https://github.com/nodejs/node/pull/22951) * Internal * Windows performance-counter support has been removed. [#22485](https://github.com/nodejs/node/pull/22485) * The `--expose-http2` command-line option has been removed. [#20887](https://github.com/nodejs/node/pull/20887) * Timers * Interval timers will be rescheduled even if previous interval threw an error. [#20002](https://github.com/nodejs/node/pull/20002) * `util` * The WHATWG `TextEncoder` and `TextDecoder` are now globals. [#22281](https://github.com/nodejs/node/pull/22281) * `util.inspect()` output size is limited to 128 MB by default. [#22756](https://github.com/nodejs/node/pull/22756) * A runtime warning will be emitted when `NODE_DEBUG` is set for either `http` or `http2`. [#21914](https://github.com/nodejs/node/pull/21914)
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/buffer.md2
-rw-r--r--doc/api/child_process.md12
-rw-r--r--doc/api/cluster.md2
-rw-r--r--doc/api/crypto.md2
-rw-r--r--doc/api/deprecations.md42
-rw-r--r--doc/api/errors.md2
-rw-r--r--doc/api/fs.md2
-rw-r--r--doc/api/globals.md6
-rw-r--r--doc/api/http.md2
-rw-r--r--doc/api/timers.md4
-rw-r--r--doc/api/tls.md2
-rw-r--r--doc/api/url.md8
-rw-r--r--doc/api/util.md16
13 files changed, 51 insertions, 51 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index c62e3380e9..1ad6549427 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -1197,7 +1197,7 @@ console.log(buf1.equals(buf3));
<!-- YAML
added: v0.5.0
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22969
description: Throws `ERR_OUT_OF_RANGE` instead of `ERR_INDEX_OUT_OF_RANGE`.
- version: v10.0.0
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index 6fe581760a..ce4f9913bd 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -131,7 +131,7 @@ exec('"my script.cmd" a b', (err, stdout, stderr) => {
<!-- YAML
added: v0.1.90
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v8.8.0
@@ -235,7 +235,7 @@ lsExample();
<!-- YAML
added: v0.1.91
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v8.8.0
@@ -381,7 +381,7 @@ The `shell` option available in [`child_process.spawn()`][] is not supported by
<!-- YAML
added: v0.1.90
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v8.8.0
@@ -690,7 +690,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/22409
description: The `input` option can now be any `TypedArray` or a
`DataView`.
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v8.8.0
@@ -760,7 +760,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/22409
description: The `input` option can now be any `TypedArray` or a
`DataView`.
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v8.8.0
@@ -822,7 +822,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/22409
description: The `input` option can now be any `TypedArray` or a
`DataView`.
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v8.8.0
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index 868d52be88..d1a4fa395e 100644
--- a/doc/api/cluster.md
+++ b/doc/api/cluster.md
@@ -703,7 +703,7 @@ values are `'rr'` and `'none'`.
<!-- YAML
added: v0.7.1
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21316
description: The `windowsHide` option now defaults to `true`.
- version: v9.5.0
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 7bf83c1437..b627054620 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -426,7 +426,7 @@ The `decipher.setAAD()` method must be called before [`decipher.update()`][].
<!-- YAML
added: v1.0.0
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/17825
description: This method now throws if the GCM tag length is invalid.
- version: v7.2.0
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index e4955f4392..47740c197a 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -227,7 +227,7 @@ to the `constants` property exposed by the relevant module. For instance,
### DEP0009: crypto.pbkdf2 without digest
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22861
description: Runtime deprecation (for `digest === null`).
- version: v8.0.0
@@ -249,7 +249,7 @@ in Node.js 6.0 because the method defaulted to using the non-recommended
Node.js 8.0.0, calling `crypto.pbkdf2()` or `crypto.pbkdf2Sync()` with
`digest` set to `undefined` will throw a `TypeError`.
-Beginning in Node.js REPLACEME, calling these functions with `digest` set to
+Beginning in Node.js v11.0.0, calling these functions with `digest` set to
`null` will print a deprecation warning to align with the behavior when `digest`
is `undefined`.
@@ -257,7 +257,7 @@ is `undefined`.
### DEP0010: crypto.createCredentials
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21153
description: End-of-Life.
- version:
@@ -279,7 +279,7 @@ The `crypto.createCredentials()` API was removed. Please use
### DEP0011: crypto.Credentials
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/21153
description: End-of-Life.
- version:
@@ -1240,7 +1240,7 @@ The [`util._extend()`][] API is deprecated.
### DEP0061: fs.SyncWriteStream
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/20735
description: End-of-Life.
- version: v8.0.0
@@ -1582,7 +1582,7 @@ Type: Runtime
### DEP0079: Custom inspection function on Objects via .inspect()
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/20722
description: End-of-Life.
- version: v10.0.0
@@ -1761,7 +1761,7 @@ same as the legacy assert but it will always use strict equality checks.
### DEP0090: Invalid GCM authentication tag lengths
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/17825
description: End-of-Life.
- version: v10.0.0
@@ -1772,7 +1772,7 @@ changes:
Type: End-of-Life
Node.js used to support all GCM authentication tag lengths which are accepted by
-OpenSSL when calling [`decipher.setAuthTag()`][]. Beginning with node REPLACEME,
+OpenSSL when calling [`decipher.setAuthTag()`][]. Beginning with node v11.0.0,
only authentication tag lengths of 128, 120, 112, 104, 96, 64, and 32 bits are
allowed. Authentication tags whose length is not included in this list are
considered invalid in compliance with [NIST SP 800-38D][].
@@ -2000,7 +2000,7 @@ assigning it to `process.env`.
### DEP0105: decipher.finaltol
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/19941
description: End-of-Life.
- version: v10.0.0
@@ -2018,7 +2018,7 @@ Type: End-of-Life
### DEP0106: crypto.createCipher and crypto.createDecipher
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22089
description: Runtime deprecation.
- version: v10.0.0
@@ -2039,7 +2039,7 @@ initialization vectors. It is recommended to derive a key using
### DEP0107: tls.convertNPNProtocols()
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/20736
description: End-of-Life.
- version: v10.0.0
@@ -2056,7 +2056,7 @@ core and obsoleted by the removal of NPN (Next Protocol Negotiation) support.
### DEP0108: zlib.bytesRead
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/23308
description: Runtime deprecation.
- version: v10.0.0
@@ -2075,7 +2075,7 @@ expose values under these names.
### DEP0109: http, https, and tls support for invalid URLs
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/20270
description: Runtime deprecation.
-->
@@ -2121,7 +2121,7 @@ only. Use of `process.binding()` by userland code is unsupported.
### DEP0112: dgram private APIs
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22011
description: Runtime deprecation.
-->
@@ -2139,7 +2139,7 @@ accessed outside of Node.js core: `Socket.prototype._handle`,
### DEP0113: Cipher.setAuthTag(), Decipher.getAuthTag()
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22126
description: Runtime deprecation.
-->
@@ -2155,7 +2155,7 @@ release.
### DEP0114: crypto._toBuf()
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22501
description: Runtime deprecation.
-->
@@ -2169,7 +2169,7 @@ of Node.js core and will be removed in the future.
### DEP0115: crypto.prng(), crypto.pseudoRandomBytes(), crypto.rng()
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url:
- https://github.com/nodejs/node/pull/22519
- https://github.com/nodejs/node/pull/23017
@@ -2204,7 +2204,7 @@ use the [WHATWG URL API][] instead.
### DEP0117: Native crypto handles
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22747
description: Runtime deprecation.
-->
@@ -2221,7 +2221,7 @@ improper use of the native object can lead to crashing the application.
### DEP0118: dns.lookup() support for a falsy hostname
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/23173
description: Runtime deprecation.
-->
@@ -2237,7 +2237,7 @@ It will become an error in future versions of Node.js.
### DEP0119: process.binding('uv').errname() private API
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/23597
description: Documentation-only deprecation.
-->
@@ -2251,7 +2251,7 @@ Please make sure to use [`util.getSystemErrorName()`][] instead.
### DEP0120: Windows Performance Counter Support
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22485
description: Runtime deprecation.
-->
diff --git a/doc/api/errors.md b/doc/api/errors.md
index 3ba2742b94..5c593e0fcd 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -1916,7 +1916,7 @@ Used when an invalid character is found in an HTTP response status message
### ERR_INDEX_OUT_OF_RANGE
<!-- YAML
added: v10.0.0
- removed: REPLACEME
+ removed: v11.0.0
-->
A given index was out of the accepted range (e.g. negative offsets).
diff --git a/doc/api/fs.md b/doc/api/fs.md
index b3af66364b..baf92fa3a2 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1410,7 +1410,7 @@ fs.copyFileSync('source.txt', 'destination.txt', COPYFILE_EXCL);
<!-- YAML
added: v0.1.31
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/19898
description: Impose new restrictions on `start` and `end`, throwing
more appropriate errors in cases when we cannot reasonably
diff --git a/doc/api/globals.md b/doc/api/globals.md
index e4965a43af..78087060a5 100644
--- a/doc/api/globals.md
+++ b/doc/api/globals.md
@@ -109,7 +109,7 @@ The process object. See the [`process` object][] section.
## queueMicrotask(callback)
<!-- YAML
-added: REPLACEME
+added: v11.0.0
-->
<!-- type=global -->
@@ -180,7 +180,7 @@ added: v0.0.1
## TextDecoder
<!-- YAML
-added: REPLACEME
+added: v11.0.0
-->
<!-- type=global -->
@@ -189,7 +189,7 @@ The WHATWG `TextDecoder` class. See the [`TextDecoder`][] section.
## TextEncoder
<!-- YAML
-added: REPLACEME
+added: v11.0.0
-->
<!-- type=global -->
diff --git a/doc/api/http.md b/doc/api/http.md
index e500db033e..d56e3b23a1 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -532,7 +532,7 @@ in the response to be dropped and the socket to be destroyed.
<!-- YAML
added: v0.11.14
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/20230
description: The `aborted` property is no longer a timestamp number.
-->
diff --git a/doc/api/timers.md b/doc/api/timers.md
index df645c104a..0221cc86be 100644
--- a/doc/api/timers.md
+++ b/doc/api/timers.md
@@ -25,7 +25,7 @@ functions that can be used to control this default behavior.
### immediate.hasRef()
<!-- YAML
-added: REPLACEME
+added: v11.0.0
-->
* Returns: {boolean}
@@ -72,7 +72,7 @@ control this default behavior.
### timeout.hasRef()
<!-- YAML
-added: REPLACEME
+added: v11.0.0
-->
* Returns: {boolean}
diff --git a/doc/api/tls.md b/doc/api/tls.md
index 217805cc19..8700839c40 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -413,7 +413,7 @@ This method is identical to [`server.listen()`][] from [`net.Server`][].
### server.setSecureContext(options)
<!-- YAML
-added: REPLACEME
+added: v11.0.0
-->
* `options` {Object} An object containing any of the possible properties from
diff --git a/doc/api/url.md b/doc/api/url.md
index d6f41a33f5..04abdf69b0 100644
--- a/doc/api/url.md
+++ b/doc/api/url.md
@@ -969,7 +969,7 @@ pathToFileURL('/some/path%.js'); // Correct: file:///some/path%25 (POSIX)
### Legacy `urlObject`
<!-- YAML
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
-->
@@ -1078,7 +1078,7 @@ forward-slash characters (`/`) are required following the colon in the
<!-- YAML
added: v0.1.25
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
- version: v7.0.0
@@ -1169,7 +1169,7 @@ The formatting process operates as follows:
<!-- YAML
added: v0.1.25
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
- version: v9.0.0
@@ -1200,7 +1200,7 @@ A `URIError` is thrown if the `auth` property is present but cannot be decoded.
<!-- YAML
added: v0.1.25
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22715
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
- version: v6.6.0
diff --git a/doc/api/util.md b/doc/api/util.md
index 3def79546b..89cfc94da3 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -1,4 +1,4 @@
-# Util
+# Util
<!--introduced_in=v0.10.0-->
@@ -194,7 +194,7 @@ changes:
first argument. This change removes previously present quotes
from strings that were being output when the first argument
was not a string.
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/17907
description: The `%o` specifier's `depth` option will now fall back to the
default depth.
@@ -377,13 +377,13 @@ stream.write('With ES6');
<!-- YAML
added: v0.3.0
changes:
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22846
description: The `depth` default changed to `20`.
- version: v10.12.0
pr-url: https://github.com/nodejs/node/pull/22788
description: The `sorted` option is supported now.
- - version: REPLACEME
+ - version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22756
description: The inspection output is now limited to about 128 MB. Data
above that size will not be fully inspected.
@@ -947,8 +947,8 @@ is not supported.
<!-- YAML
added: v8.3.0
changes:
- - version: REPLACEME
- pr-url: REPLACEME
+ - version: v11.0.0
+ pr-url: v11.0.0
description: The class is now available on the global object.
-->
@@ -1008,8 +1008,8 @@ mark.
<!-- YAML
added: v8.3.0
changes:
- - version: REPLACEME
- pr-url: REPLACEME
+ - version: v11.0.0
+ pr-url: v11.0.0
description: The class is now available on the global object.
-->