diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/assert.md | 2 | ||||
-rw-r--r-- | doc/api/buffer.md | 8 | ||||
-rw-r--r-- | doc/api/cli.md | 38 | ||||
-rw-r--r-- | doc/api/crypto.md | 22 | ||||
-rw-r--r-- | doc/api/deprecations.md | 44 | ||||
-rw-r--r-- | doc/api/dgram.md | 10 | ||||
-rw-r--r-- | doc/api/errors.md | 2 | ||||
-rw-r--r-- | doc/api/fs.md | 4 | ||||
-rw-r--r-- | doc/api/http.md | 2 | ||||
-rw-r--r-- | doc/api/process.md | 2 | ||||
-rw-r--r-- | doc/api/repl.md | 4 | ||||
-rw-r--r-- | doc/api/tls.md | 4 | ||||
-rw-r--r-- | doc/api/util.md | 8 |
13 files changed, 75 insertions, 75 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 67bc9afbab..9028d21f0d 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -163,7 +163,7 @@ An alias of [`assert.ok()`][]. <!-- YAML added: v0.1.21 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25008 description: The type tags are now properly compared and there are a couple minor comparison adjustments to make the check less surprising. diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 13b6ce589c..dfb18eeb56 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -1549,7 +1549,7 @@ The `buf.parent` property is a deprecated alias for `buf.buffer`. ### buf.readBigInt64BE([offset]) ### buf.readBigInt64LE([offset]) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `offset` {integer} Number of bytes to skip before starting to read. Must @@ -1565,7 +1565,7 @@ Integers read from a `Buffer` are interpreted as two's complement signed values. ### buf.readBigUInt64BE([offset]) ### buf.readBigUInt64LE([offset]) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `offset` {integer} Number of bytes to skip before starting to read. Must @@ -2192,7 +2192,7 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`); ### buf.writeBigInt64BE(value[, offset]) ### buf.writeBigInt64LE(value[, offset]) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `value` {bigint} Number to be written to `buf`. @@ -2218,7 +2218,7 @@ console.log(buf); ### buf.writeBigUInt64BE(value[, offset]) ### buf.writeBigUInt64LE(value[, offset]) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `value` {bigint} Number to be written to `buf`. diff --git a/doc/api/cli.md b/doc/api/cli.md index fed5aa90aa..c0682d864c 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -77,7 +77,7 @@ $ source node_bash_completion ### `--cpu-prof` <!-- YAML -added: REPLACEME +added: v12.0.0 --> > Stability: 1 - Experimental @@ -99,7 +99,7 @@ CPU.20190409.202950.15293.0.0.cpuprofile ### `--cpu-prof-dir` <!-- YAML -added: REPLACEME +added: v12.0.0 --> > Stability: 1 - Experimental @@ -109,7 +109,7 @@ be placed. ### `--cpu-prof-name` <!-- YAML -added: REPLACEME +added: v12.0.0 --> > Stability: 1 - Experimental @@ -126,7 +126,7 @@ Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with ### `--es-module-specifier-resolution=mode` <!-- YAML -added: REPLACEME +added: v12.0.0 --> To be used in conjunction with `--experimental-modules`. Sets the resolution @@ -140,7 +140,7 @@ Please see [customizing esm specifier resolution][] for example usage. ### `--experimental-json-modules` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Enable experimental JSON support for the ES Module loader. @@ -209,7 +209,7 @@ Both of the above may change in future updates, which will be breaking changes. ### `--heapsnapshot-signal=signal` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Generates a heap snapshot each time the process receives the specified signal. @@ -240,7 +240,7 @@ Specify ICU data load path. (Overrides `NODE_ICU_DATA`.) ### `--input-type=type` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Used with `--experimental-modules`, this configures Node.js to interpret string @@ -455,7 +455,7 @@ warning will be written to stderr instead. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: Changed from `--diagnostic-report-directory` to `--report-directory` @@ -467,7 +467,7 @@ Location at which the report will be generated. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-filename` to `--report-filename` @@ -479,7 +479,7 @@ Name of the file to which the report will be written. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-on-fatalerror` to `--report-on-fatalerror` @@ -495,7 +495,7 @@ consumption etc. to reason about the fatal error. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-on-signal` to `--report-on-signal` @@ -509,7 +509,7 @@ The signal to trigger the report is specified through `--report-signal`. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-signal` to `--report-signal` @@ -522,7 +522,7 @@ Default signal is `SIGUSR2`. <!-- YAML added: v11.8.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-uncaught-exception` to `--report-uncaught-exception` @@ -556,7 +556,7 @@ with crypto support (default). ### `--tls-max-v1.2` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Set [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.2'. Use to disable support for @@ -564,7 +564,7 @@ TLSv1.3. ### `--tls-max-v1.3` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Set default [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.3'. Use to enable support @@ -572,7 +572,7 @@ for TLSv1.3. ### `--tls-min-v1.0` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1'. Use for compatibility with @@ -580,7 +580,7 @@ old TLS clients or servers. ### `--tls-min-v1.1` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.1'. Use for compatibility @@ -588,7 +588,7 @@ with old TLS clients or servers. ### `--tls-min-v1.3` <!-- YAML -added: REPLACEME +added: v12.0.0 --> Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.3'. Use to disable support @@ -648,7 +648,7 @@ Track heap object allocations for heap snapshots. ### `--unhandled-rejections=mode` <!-- YAML -added: REPLACEME +added: v12.0.0 --> By default all unhandled rejections trigger a warning plus a deprecation warning diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 9ba401f153..e6392d2d51 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1129,17 +1129,17 @@ passing keys as strings or `Buffer`s due to improved security features. <!-- YAML added: v11.6.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26960 description: Added support for `'rsa-pss'` - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26786 description: This property now returns `undefined` for KeyObject instances of unrecognized type instead of aborting. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26774 description: Added support for `'x25519'` and `'x448'` - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26319 description: Added support for `'ed25519'` and `'ed448'`. --> @@ -1284,7 +1284,7 @@ console.log(verify.verify(publicKey, signature)); <!-- YAML added: v0.1.92 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26960 description: This function now supports RSA-PSS keys. - version: v11.6.0 @@ -1387,7 +1387,7 @@ This can be called many times with new data as it is streamed. <!-- YAML added: v0.1.92 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26960 description: This function now supports RSA-PSS keys. - version: v11.7.0 @@ -1937,10 +1937,10 @@ algorithm names. <!-- YAML added: v10.12.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26774 description: Add ability to generate X25519 and X448 key pairs. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26554 description: Add ability to generate Ed25519 and Ed448 key pairs. - version: v11.6.0 @@ -2001,7 +2001,7 @@ a `Promise` for an `Object` with `publicKey` and `privateKey` properties. <!-- YAML added: v10.12.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26554 description: Add ability to generate Ed25519 and Ed448 key pairs. - version: v11.6.0 @@ -2692,7 +2692,7 @@ Throws an error if FIPS mode is not available. ### crypto.sign(algorithm, data, key) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `algorithm` {string | null | undefined} * `data` {Buffer | TypedArray | DataView} @@ -2742,7 +2742,7 @@ not introduce timing vulnerabilities. ### crypto.verify(algorithm, data, key, signature) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `algorithm` {string | null | undefined} * `data` {Buffer | TypedArray | DataView} diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index cf06f69fc8..f2c737bddd 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -160,7 +160,7 @@ outside `node_modules` in order to better target developers, rather than users. ### DEP0006: child\_process options.customFds <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25279 description: End-of-Life. - version: @@ -442,7 +442,7 @@ code. ### DEP0019: require('.') resolved outside directory <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26973 description: Removed functionality. - version: @@ -483,7 +483,7 @@ The [`Server.connections`][] property is deprecated. Please use the ### DEP0021: Server.listenFD <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27127 description: End-of-Life. - version: @@ -518,7 +518,7 @@ The `os.tmpDir()` API is deprecated. Please use [`os.tmpdir()`][] instead. ### DEP0023: os.getNetworkInterfaces() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25280 description: End-of-Life. - version: @@ -574,7 +574,7 @@ The `sys` module is deprecated. Please use the [`util`][] module instead. ### DEP0026: util.print() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25377 description: End-of-Life. - version: @@ -595,7 +595,7 @@ Type: End-of-Life ### DEP0027: util.puts() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25377 description: End-of-Life. - version: @@ -616,7 +616,7 @@ Type: End-of-Life ### DEP0028: util.debug() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25377 description: End-of-Life. - version: @@ -637,7 +637,7 @@ Type: End-of-Life ### DEP0029: util.error() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25377 description: End-of-Life. - version: @@ -1284,7 +1284,7 @@ changes: - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/10970 description: Runtime deprecation. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25828 description: End-of-Life. --> @@ -1367,7 +1367,7 @@ removed. Please use `sloppy` instead. ### DEP0066: outgoingMessage.\_headers, outgoingMessage.\_headerNames <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/24167 description: Runtime deprecation. - version: v8.0.0 @@ -1693,7 +1693,7 @@ the client and is now unsupported. Use the `ciphers` parameter instead. ### DEP0084: requiring bundled internal dependencies <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25138 description: This functionality has been removed. - version: v10.0.0 @@ -1910,7 +1910,7 @@ should start using the `async_context` variant of `MakeCallback` or ### DEP0098: AsyncHooks Embedder AsyncResource.emitBefore and AsyncResource.emitAfter APIs <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26530 description: End-of-Life - version: @@ -2173,7 +2173,7 @@ accessed outside of Node.js core: `Socket.prototype._handle`, ### DEP0113: Cipher.setAuthTag(), Decipher.getAuthTag() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26249 description: End-of-Life. - version: v11.0.0 @@ -2190,7 +2190,7 @@ were never documented and would throw when called. ### DEP0114: crypto._toBuf() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25338 description: End-of-Life. - version: v11.0.0 @@ -2242,7 +2242,7 @@ use the [WHATWG URL API][] instead. ### DEP0117: Native crypto handles <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27011 description: End-of-Life. - version: v11.0.0 @@ -2292,7 +2292,7 @@ Type: Documentation-only (supports [`--pending-deprecation`][]) ### DEP0120: Windows Performance Counter Support <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/24862 description: End-of-Life. - version: v11.0.0 @@ -2312,7 +2312,7 @@ undocumented `COUNTER_NET_SERVER_CONNECTION()`, ### DEP0121: net._setSimultaneousAccepts() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23760 description: Runtime deprecation. --> @@ -2327,7 +2327,7 @@ https://github.com/nodejs/node/issues/18391 ### DEP0122: tls Server.prototype.setOptions() <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23820 description: Runtime deprecation. --> @@ -2340,7 +2340,7 @@ Please use `Server.prototype.setSecureContext()` instead. ### DEP0123: setting the TLS ServerName to an IP address <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23329 description: Runtime deprecation. --> @@ -2354,7 +2354,7 @@ Setting the TLS ServerName to an IP address is not permitted by ### DEP0124: using REPLServer.rli <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26260 description: Runtime deprecation. --> @@ -2367,7 +2367,7 @@ This property is a reference to the instance itself. ### DEP0125: require('\_stream\_wrap') <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26245 description: Runtime deprecation. --> @@ -2412,7 +2412,7 @@ with no performance impact since Node.js 10. ### DEP0128: modules with an invalid `main` entry and an `index.js` file <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26823 description: Documentation-only. --> diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 7ef483bc23..1d815ba56b 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -51,7 +51,7 @@ Once triggered, no new `'message'` events will be emitted on this socket. ### Event: 'connect' <!-- YAML -added: REPLACEME +added: v12.0.0 --> The `'connect'` event is emitted after a socket is associated to a remote @@ -247,7 +247,7 @@ provided, it is added as a listener for the [`'close'`][] event. ### socket.connect(port[, address][, callback]) <!-- YAML -added: REPLACEME +added: v12.0.0 --> * `port` {integer} @@ -266,7 +266,7 @@ the `callback` is called or, failing this, an `'error'` event is emitted. ### socket.disconnect() <!-- YAML -added: REPLACEME +added: v12.0.0 --> A synchronous function that disassociates a connected `dgram.Socket` from @@ -321,7 +321,7 @@ chained. ### socket.remoteAddress() <!-- YAML -added: REPLACEME +added: v12.0.0 --> * Returns: {Object} @@ -348,7 +348,7 @@ changes: pr-url: https://github.com/nodejs/node/pull/4374 description: The `msg` parameter can be an array now. Also, the `offset` and `length` parameters are optional now. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26871 description: Added support for sending data on connected sockets. --> diff --git a/doc/api/errors.md b/doc/api/errors.md index 097b0208f7..a21b4ac852 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -1989,7 +1989,7 @@ an `Error` with this code will be emitted. ### MODULE_NOT_FOUND <!-- YAML changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25690 description: Added `requireStack` property. --> diff --git a/doc/api/fs.md b/doc/api/fs.md index c96b2cf5c5..0ce63f98ce 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3043,7 +3043,7 @@ changes: description: The `target` and `path` parameters can be WHATWG `URL` objects using `file:` protocol. Support is currently still *experimental*. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23724 description: If the `type` argument is left undefined, Node will autodetect `target` type and automatically select `dir` or `file` @@ -3081,7 +3081,7 @@ changes: description: The `target` and `path` parameters can be WHATWG `URL` objects using `file:` protocol. Support is currently still *experimental*. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23724 description: If the `type` argument is left undefined, Node will autodetect `target` type and automatically select `dir` or `file` diff --git a/doc/api/http.md b/doc/api/http.md index 927e64554e..ccd5e4b0bd 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -838,7 +838,7 @@ changes: description: The `rawPacket` is the current buffer that just parsed. Adding this buffer to the error object of `'clientError'` event is to make it possible that developers can log the broken packet. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25605 description: The default behavior will return a 431 Request Header Fields Too Large if a HPE_HEADER_OVERFLOW error occurs. diff --git a/doc/api/process.md b/doc/api/process.md index 95f57f6932..c868f01fa1 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -206,7 +206,7 @@ most convenient for scripts). <!-- YAML added: v0.1.18 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26599 description: Added the `origin` argument. --> diff --git a/doc/api/repl.md b/doc/api/repl.md index cc7f3f96da..b4ee0b7bdb 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -479,8 +479,8 @@ with REPL instances programmatically. <!-- YAML added: v0.1.91 changes: - - version: REPLACEME - pr-url: https://github.com/nodejs/node/pull/REPLACEME + - version: v12.0.0 + pr-url: https://github.com/nodejs/node/pull/v12.0.0 description: The `terminal` option now follows the default description in all cases and `useColors` checks `hasColors()` if available. - version: v10.0.0 diff --git a/doc/api/tls.md b/doc/api/tls.md index 65897ab315..6a834c65ff 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -753,7 +753,7 @@ socket has been destroyed, `null` will be returned. <!-- YAML added: v0.11.4 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26625 description: Return the minimum cipher version, instead of a fixed string (`'TLSv1/SSLv3'`). @@ -1264,7 +1264,7 @@ argument. <!-- YAML added: v0.11.13 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26209 description: TLSv1.3 support added. - version: v11.5.0 diff --git a/doc/api/util.md b/doc/api/util.md index 3c01170673..c0b909d438 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -187,11 +187,11 @@ changes: pr-url: https://github.com/nodejs/node/pull/23708 description: The `%d`, `%f` and `%i` specifiers now support Symbols properly. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23162 description: The `format` argument is now only taken as such if it actually contains format specifiers. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23162 description: If the `format` argument is not a format string, the output string's formatting is no longer dependent on the type of the @@ -390,14 +390,14 @@ stream.write('With ES6'); <!-- YAML added: v0.3.0 changes: - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27109 description: The `compact` options default is changed to `3` and the `breakLength` options default is changed to `80`. - version: v11.11.0 pr-url: https://github.com/nodejs/node/pull/26269 description: The `compact` option accepts numbers for a new output mode. - - version: REPLACEME + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/24971 description: Internal properties no longer appear in the context argument of a custom inspection function. |