diff options
| author | Michaël Zasso <targos@protonmail.com> | 2020-05-01 14:43:14 +0200 |
|---|---|---|
| committer | Michaël Zasso <targos@protonmail.com> | 2020-05-25 13:32:25 +0200 |
| commit | cd4ae7c92508a6dcfe2e62e686a62130fead3222 (patch) | |
| tree | 43cacdfd6304dd0df606adefdef1caec470e0254 /doc/api | |
| parent | ebd9090240ca912f126e354da559c068139928d8 (diff) | |
| download | node-new-v12.17.0-proposal.tar.gz | |
2020-05-26, Version 12.17.0 'Erbium' (LTS)v12.17.0v12.17.0-proposal
Notable changes:
* ECMAScript Modules - `--experimental-modules` flag removal
* AsyncLocalStorage API (experimental)
* REPL previews
* REPL reverse-i-search
* REPL substring-based search
* Error monitoring
* Monitoring `error` events
* Monitoring uncaught exceptions
* File system APIs
* New function: `fs.readv`
* Optional parameters in `fs.read`
* Console `groupIndentation` option
* `maxStringLength` option for `util.inspect()`
* Stable N-API release 6
* Stable diagnostic reports
* Increase of the default server headers timeout
* New `--trace-sigint` CLI flag
* Various crypto APIs now support Diffie-Hellman secrets
* Added support for the `dns.ALL` flag in `dns.lookup()`
* Added a new experimental API to interact with Source Map V3 data
* Added support for passing a `transferList` along with `workerData` to
the `Worker` constructor
PR-URL: https://github.com/nodejs/node/pull/33197
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/async_hooks.md | 16 | ||||
| -rw-r--r-- | doc/api/cli.md | 20 | ||||
| -rw-r--r-- | doc/api/console.md | 2 | ||||
| -rw-r--r-- | doc/api/crypto.md | 8 | ||||
| -rw-r--r-- | doc/api/dns.md | 2 | ||||
| -rw-r--r-- | doc/api/errors.md | 2 | ||||
| -rw-r--r-- | doc/api/events.md | 2 | ||||
| -rw-r--r-- | doc/api/fs.md | 26 | ||||
| -rw-r--r-- | doc/api/modules.md | 6 | ||||
| -rw-r--r-- | doc/api/n-api.md | 10 | ||||
| -rw-r--r-- | doc/api/os.md | 2 | ||||
| -rw-r--r-- | doc/api/perf_hooks.md | 2 | ||||
| -rw-r--r-- | doc/api/process.md | 22 | ||||
| -rw-r--r-- | doc/api/repl.md | 4 | ||||
| -rw-r--r-- | doc/api/tls.md | 2 | ||||
| -rw-r--r-- | doc/api/util.md | 2 | ||||
| -rw-r--r-- | doc/api/vm.md | 2 | ||||
| -rw-r--r-- | doc/api/worker_threads.md | 6 |
18 files changed, 68 insertions, 68 deletions
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 5932d6fda3..d071820a29 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -467,7 +467,7 @@ init for PROMISE with id 6, trigger id: 5 # the Promise returned by then() #### `async_hooks.executionAsyncResource()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * Returns: {Object} The resource representing the current execution. @@ -869,7 +869,7 @@ for (let i = 0; i < 10; i++) { ## Class: `AsyncLocalStorage` <!-- YAML -added: REPLACEME +added: v12.17.0 --> This class is used to create asynchronous state within callbacks and promise @@ -918,7 +918,7 @@ from each other. It is safe to instantiate this class multiple times. ### `new AsyncLocalStorage()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> Creates a new instance of `AsyncLocalStorage`. Store is only provided within a @@ -926,7 +926,7 @@ Creates a new instance of `AsyncLocalStorage`. Store is only provided within a ### `asyncLocalStorage.disable()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> This method disables the instance of `AsyncLocalStorage`. All subsequent calls @@ -946,7 +946,7 @@ in the current process. ### `asyncLocalStorage.getStore()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * Returns: {any} @@ -957,7 +957,7 @@ calling `asyncLocalStorage.run`, it will return `undefined`. ### `asyncLocalStorage.enterWith(store)` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `store` {any} @@ -999,7 +999,7 @@ asyncLocalStorage.getStore(); // Returns the same object ### `asyncLocalStorage.run(store, callback[, ...args])` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `store` {any} @@ -1034,7 +1034,7 @@ try { ### `asyncLocalStorage.exit(callback[, ...args])` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `callback` {Function} diff --git a/doc/api/cli.md b/doc/api/cli.md index e77e7c874c..5dd5ae404b 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -129,7 +129,7 @@ Specify the file name of the CPU profile generated by `--cpu-prof`. ### `--disable-proto=mode` <!--YAML -added: REPLACEME +added: v12.17.0 --> Disable the `Object.prototype.__proto__` property. If `mode` is `delete`, the @@ -625,7 +625,7 @@ warning will be written to stderr instead. ### `--report-compact` <!-- YAML -added: REPLACEME +added: v12.17.0 --> Write reports in a compact format, single-line JSON, more easily consumable @@ -636,7 +636,7 @@ human consumption. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This option is no longer considered experimental. - version: v12.0.0 @@ -651,7 +651,7 @@ Location at which the report will be generated. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This option is no longer considered experimental. - version: v12.0.0 @@ -666,7 +666,7 @@ Name of the file to which the report will be written. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32496 description: This option is no longer considered experimental. - version: v12.0.0 @@ -685,7 +685,7 @@ error. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This option is no longer considered experimental. - version: v12.0.0 @@ -702,7 +702,7 @@ specified through `--report-signal`. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This option is no longer considered experimental. - version: v12.0.0 @@ -718,7 +718,7 @@ Default signal is `SIGUSR2`. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This option is no longer considered experimental. - version: v12.0.0 @@ -851,7 +851,7 @@ i.e. invoking `process.exit()`. ### `--trace-sigint` <!-- YAML -added: REPLACEME +added: v12.17.0 --> Prints a stack trace on SIGINT. @@ -937,7 +937,7 @@ See `SSL_CERT_DIR` and `SSL_CERT_FILE`. ### `--use-largepages=mode` <!-- YAML -added: REPLACEME +added: v12.17.0 --> Re-map the Node.js static code to large memory pages at startup. If supported on diff --git a/doc/api/console.md b/doc/api/console.md index 9122b85efa..1498c6d30e 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -81,7 +81,7 @@ const { Console } = console; ### `new Console(options)` <!-- YAML changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32964 description: The `groupIndentation` option was introduced. - version: v11.7.0 diff --git a/doc/api/crypto.md b/doc/api/crypto.md index a24121f7aa..5b84cd1835 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1232,7 +1232,7 @@ passing keys as strings or `Buffer`s due to improved security features. <!-- YAML added: v11.6.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31178 description: Added support for `'dh'`. - version: v12.0.0 @@ -2091,7 +2091,7 @@ algorithm names. ### `crypto.diffieHellman(options)` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `options`: {Object} @@ -2107,7 +2107,7 @@ Both keys must have the same `asymmetricKeyType`, which must be one of `'dh'` <!-- YAML added: v10.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31178 description: Add support for Diffie-Hellman. - version: v12.0.0 @@ -2180,7 +2180,7 @@ a `Promise` for an `Object` with `publicKey` and `privateKey` properties. <!-- YAML added: v10.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31178 description: Add support for Diffie-Hellman. - version: v12.0.0 diff --git a/doc/api/dns.md b/doc/api/dns.md index 53c7dcece7..4467b53b94 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -202,7 +202,7 @@ is not set to `true`, it returns a `Promise` for an `Object` with `address` and ### Supported getaddrinfo flags <!-- YAML changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32183 description: Added support for the `dns.ALL` flag. --> diff --git a/doc/api/errors.md b/doc/api/errors.md index bf30bfcfe5..c061b40b7e 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -1868,7 +1868,7 @@ The context must be a `SecureContext`. <a id="ERR_TLS_INVALID_STATE"></a> ### `ERR_TLS_INVALID_STATE` <!-- YAML -added: REPLACEME +added: v12.17.0 --> The TLS socket must be connected and securily established. Ensure the 'secure' diff --git a/doc/api/events.md b/doc/api/events.md index 29a686d526..0a18091fdf 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -362,7 +362,7 @@ Its `name` property is set to `'MaxListenersExceededWarning'`. ### `EventEmitter.errorMonitor` <!-- YAML -added: REPLACEME +added: v12.17.0 --> This symbol shall be used to install a listener for only monitoring `'error'` diff --git a/doc/api/fs.md b/doc/api/fs.md index 691e329e46..53e650ac07 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1675,7 +1675,7 @@ changes: - version: v2.3.0 pr-url: https://github.com/nodejs/node/pull/1845 description: The passed `options` object can be a string now. - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/29083 description: The `fs` options allow overriding the used `fs` implementation. @@ -1778,8 +1778,8 @@ changes: - version: v2.3.0 pr-url: https://github.com/nodejs/node/pull/1845 description: The passed `options` object can be a string now. - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/REPLACEME + - version: v12.17.0 + pr-url: https://github.com/nodejs/node/pull/v12.17.0 description: The `fs` options allow overriding the used `fs` implementation. --> @@ -2439,7 +2439,7 @@ Synchronous lstat(2). <!-- YAML added: v0.1.8 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31530 description: In `recursive` mode, the callback now receives the first created path as an argument. @@ -2501,7 +2501,7 @@ See also: mkdir(2). <!-- YAML added: v0.1.21 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31530 description: In `recursive` mode, the first created path is returned now. - version: v10.12.0 @@ -2785,9 +2785,9 @@ a `Promise` for an `Object` with `bytesRead` and `buffer` properties. ## `fs.read(fd, [options,] callback)` <!-- YAML -added: REPLACEME +added: v12.17.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31402 description: Options object can be passed in to make Buffer, offset, length and position optional @@ -3083,9 +3083,9 @@ this API: [`fs.read()`][]. ## `fs.readSync(fd, buffer, [options])` <!-- YAML -added: REPLACEME +added: v12.17.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32460 description: Options object can be passed in to make offset, length and position optional @@ -3109,7 +3109,7 @@ this API: [`fs.read()`][]. ## `fs.readv(fd, buffers[, position], callback)` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `fd` {integer} @@ -3132,7 +3132,7 @@ The callback will be given three arguments: `err`, `bytesRead`, and ## `fs.readvSync(fd, buffers[, position])` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `fd` {integer} @@ -4460,7 +4460,7 @@ property that is a reference to the passed in `buffer` argument. #### `filehandle.read(options)` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `options` {Object} * `buffer` {Buffer|Uint8Array} **Default:** `Buffer.alloc(16384)` @@ -4495,7 +4495,7 @@ of the file. #### `filehandle.readv(buffers[, position])` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `buffers` {ArrayBufferView[]} diff --git a/doc/api/modules.md b/doc/api/modules.md index 7c524bfddf..8b06b02f2f 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -1026,7 +1026,7 @@ import('fs').then((esmFS) => { ## Source Map V3 Support <!-- YAML -added: REPLACEME +added: v12.17.0 --> > Stability: 1 - Experimental @@ -1045,7 +1045,7 @@ const { findSourceMap, SourceMap } = require('module'); ### `module.findSourceMap(path[, error])` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `path` {string} @@ -1063,7 +1063,7 @@ will be associated with the `error` instance along with the `path`. ### Class: `module.SourceMap` <!-- YAML -added: REPLACEME +added: v12.17.0 --> #### `new SourceMap(payload)` diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 3fc236bba0..d635ccba26 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -248,7 +248,7 @@ listed as supporting a later version. | v9.x | v9.0.0* | v9.3.0* | v9.11.0* | | | | | v10.x | v10.0.0 | v10.0.0 | v10.0.0 | v10.16.0 | v10.17.0 | v10.20.0 | | v11.x | v11.0.0 | v11.0.0 | v11.0.0 | v11.8.0 | | | -| v12.x | v12.0.0 | v12.0.0 | v12.0.0 | v12.0.0 | v12.11.0 | REPLACEME | +| v12.x | v12.0.0 | v12.0.0 | v12.0.0 | v12.0.0 | v12.11.0 | v12.17.0 | | v13.x | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | | | v14.x | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | @@ -1664,7 +1664,7 @@ the `napi_value` in question is of the JavaScript type expected by the API. ### Enum types #### napi_key_collection_mode <!-- YAML -added: REPLACEME +added: v12.17.0 napiVersion: 6 --> @@ -1685,7 +1685,7 @@ of the objects's prototype chain as well. #### napi_key_filter <!-- YAML -added: REPLACEME +added: v12.17.0 napiVersion: 6 --> @@ -1704,7 +1704,7 @@ Property filter bits. They can be or'ed to build a composite filter. #### napi_key_conversion <!-- YAML -added: REPLACEME +added: v12.17.0 napiVersion: 6 --> @@ -3591,7 +3591,7 @@ included. #### napi_get_all_property_names <!-- YAML -added: REPLACEME +added: v12.17.0 napiVersion: 6 --> diff --git a/doc/api/os.md b/doc/api/os.md index 66b6bd2932..b6e502f3b5 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -391,7 +391,7 @@ Throws a [`SystemError`][] if a user has no `username` or `homedir`. ## `os.version()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * Returns {string} diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index ebfddc3cee..c17c95c3d6 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -211,7 +211,7 @@ The value may be one of: ### performanceEntry.flags <!-- YAML -added: REPLACEME +added: v12.17.0 --> * {number} diff --git a/doc/api/process.md b/doc/api/process.md index 7df2401539..c9222bb3fb 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -295,7 +295,7 @@ needed. ### Event: `'uncaughtExceptionMonitor'` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `err` {Error} The uncaught exception. @@ -1488,7 +1488,7 @@ is no entry script. <!-- YAML added: v0.1.16 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31550 description: Added `arrayBuffers` to the returned object. - version: v7.2.0 @@ -1756,7 +1756,7 @@ relied upon to exist. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1769,7 +1769,7 @@ reports for the current process. Additional documentation is available in the ### `process.report.compact` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * {boolean} @@ -1786,7 +1786,7 @@ console.log(`Reports are compact? ${process.report.compact}`); <!-- YAML added: v11.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1805,7 +1805,7 @@ console.log(`Report directory is ${process.report.directory}`); <!-- YAML added: v11.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1824,7 +1824,7 @@ console.log(`Report filename is ${process.report.filename}`); <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1867,7 +1867,7 @@ console.log(`Report on fatal error: ${process.report.reportOnFatalError}`); <!-- YAML added: v11.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1885,7 +1885,7 @@ console.log(`Report on signal: ${process.report.reportOnSignal}`); <!-- YAML added: v11.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1902,7 +1902,7 @@ console.log(`Report on exception: ${process.report.reportOnUncaughtException}`); <!-- YAML added: v11.12.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> @@ -1920,7 +1920,7 @@ console.log(`Report signal: ${process.report.signal}`); <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32242 description: This API is no longer considered experimental. --> diff --git a/doc/api/repl.md b/doc/api/repl.md index 434435c71e..50845785cf 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -240,7 +240,7 @@ undefined ### Reverse-i-search <!-- YAML -added: REPLACEME +added: v12.17.0 --> The REPL supports bi-directional reverse-i-search similar to [ZSH][]. It is @@ -544,7 +544,7 @@ with REPL instances programmatically. <!-- YAML added: v0.1.91 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/30811 description: The `preview` option is now available. - version: v12.0.0 diff --git a/doc/api/tls.md b/doc/api/tls.md index 2241f2afc5..9528819b33 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1096,7 +1096,7 @@ for more information. ### `tlsSocket.exportKeyingMaterial(length, label[, context])` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * `length` {number} number of bytes to retrieve from keying material diff --git a/doc/api/util.md b/doc/api/util.md index 107efabbf8..ab2e94ef60 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -398,7 +398,7 @@ stream.write('With ES6'); <!-- YAML added: v0.3.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32392 description: The `maxStringLength` option is supported now. - version: v12.16.0 diff --git a/doc/api/vm.md b/doc/api/vm.md index 1e1533b919..0d6b45a4ca 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -624,7 +624,7 @@ const contextifiedObject = vm.createContext({ secret: 42 }); ### `sourceTextModule.createCachedData()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * Returns: {Buffer} diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 11215d065e..8db0f807fa 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -513,10 +513,10 @@ if (isMainThread) { <!-- YAML added: v10.5.0 changes: - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/32278 description: The `transferList` option was introduced. - - version: REPLACEME + - version: v12.17.0 pr-url: https://github.com/nodejs/node/pull/31664 description: The `filename` parameter can be a WHATWG `URL` object using `file:` protocol. @@ -627,7 +627,7 @@ JavaScript code. ### `worker.getHeapSnapshot()` <!-- YAML -added: REPLACEME +added: v12.17.0 --> * Returns: {Promise} A promise for a Readable Stream containing |
