diff options
author | Anna Henningsen <anna@addaleax.net> | 2017-02-22 00:10:25 +0100 |
---|---|---|
committer | Anna Henningsen <anna@addaleax.net> | 2017-02-24 02:06:31 +0100 |
commit | 5da952472b4bf495674b68eeee02f06eda3d626a (patch) | |
tree | 3713b8e3027b973bcb582178edfa0020d5c69e57 | |
parent | adcd0bd9b457668930e0d5105426929a9b1b8fbd (diff) | |
download | android-node-v8-5da952472b4bf495674b68eeee02f06eda3d626a.tar.gz android-node-v8-5da952472b4bf495674b68eeee02f06eda3d626a.tar.bz2 android-node-v8-5da952472b4bf495674b68eeee02f06eda3d626a.zip |
doc: document pending semver-major API changes
PR-URL: https://github.com/nodejs/node/pull/11489
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Italo A. Casas <me@italoacasas.com>
-rw-r--r-- | doc/api/buffer.md | 29 | ||||
-rw-r--r-- | doc/api/child_process.md | 14 | ||||
-rw-r--r-- | doc/api/console.md | 7 | ||||
-rw-r--r-- | doc/api/crypto.md | 3 | ||||
-rw-r--r-- | doc/api/dgram.md | 3 | ||||
-rw-r--r-- | doc/api/querystring.md | 3 | ||||
-rw-r--r-- | doc/api/string_decoder.md | 5 |
7 files changed, 64 insertions, 0 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md index e79fe978e2..650e9ed981 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -704,6 +704,10 @@ actual byte length is returned. ### Class Method: Buffer.compare(buf1, buf2) <!-- YAML added: v0.11.13 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The arguments can now be `Uint8Array`s. --> * `buf1` {Buffer|Uint8Array} @@ -729,6 +733,10 @@ console.log(arr.sort(Buffer.compare)); ### Class Method: Buffer.concat(list[, totalLength]) <!-- YAML added: v0.7.11 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The elements of `list` can now be `Uint8Array`s. --> * `list` {Array} List of `Buffer` or [`Uint8Array`] instances to concat @@ -966,6 +974,9 @@ console.log(buffer.buffer === arrayBuffer); <!-- YAML added: v0.11.13 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The `target` parameter can now be a `Uint8Array`. - version: v5.11.0 pr-url: https://github.com/nodejs/node/pull/5880 description: Additional parameters for specifying offsets are supported now. @@ -1124,6 +1135,10 @@ for (const pair of buf.entries()) { ### buf.equals(otherBuffer) <!-- YAML added: v0.11.13 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The arguments can now be `Uint8Array`s. --> * `otherBuffer` {Buffer} A `Buffer` or [`Uint8Array`] to compare to @@ -1232,6 +1247,9 @@ console.log(buf.includes('this', 4)); <!-- YAML added: v1.5.0 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The `value` can now be a `Uint8Array`. - version: v5.7.0, v4.4.0 pr-url: https://github.com/nodejs/node/pull/4803 description: When `encoding` is being passed, the `byteOffset` parameter @@ -1341,6 +1359,10 @@ for (const key of buf.keys()) { ### buf.lastIndexOf(value[, byteOffset][, encoding]) <!-- YAML added: v6.0.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The `value` can now be a `Uint8Array`. --> * `value` {String | Buffer | Uint8Array | Integer} What to search for @@ -1464,6 +1486,9 @@ console.log(buf.length); ``` ### buf.parent +<!-- YAML +deprecated: REPLACEME +--> > Stability: 0 - Deprecated: Use [`buf.buffer`] instead. @@ -2475,6 +2500,10 @@ Note that this is a property on the `buffer` module returned by ## buffer.transcode(source, fromEnc, toEnc) <!-- YAML added: v7.1.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10236 + description: The `source` parameter can now be a `Uint8Array`. --> * `source` {Buffer|Uint8Array} A `Buffer` or `Uint8Array` instance diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 50409b0295..c653ba0d85 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -252,6 +252,9 @@ encoding, `Buffer` objects will be passed to the callback instead. <!-- YAML added: v0.5.0 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10866 + description: The `stdio` option can now be a string. - version: v6.4.0 pr-url: https://github.com/nodejs/node/pull/7811 description: The `stdio` option is supported now. @@ -590,6 +593,9 @@ configuration at startup. <!-- YAML added: v0.11.12 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10653 + description: The `input` option can now be a `Uint8Array`. - version: v6.2.1, v4.5.0 pr-url: https://github.com/nodejs/node/pull/6939 description: The `encoding` option can now explicitly be set to `buffer`. @@ -632,6 +638,10 @@ throw. The [`Error`][] object will contain the entire result from ### child_process.execSync(command[, options]) <!-- YAML added: v0.11.12 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10653 + description: The `input` option can now be a `Uint8Array`. --> * `command` {String} The command to run @@ -680,6 +690,9 @@ execution.** <!-- YAML added: v0.11.12 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10653 + description: The `input` option can now be a `Uint8Array`. - version: v6.2.1, v4.5.0 pr-url: https://github.com/nodejs/node/pull/6939 description: The `encoding` option can now explicitly be set to `buffer`. @@ -1234,3 +1247,4 @@ to `stdout` although there are only 4 characters. [`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback [`stdio`]: #child_process_options_stdio [synchronous counterparts]: #child_process_synchronous_process_creation +[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array diff --git a/doc/api/console.md b/doc/api/console.md index 45566a9cdf..122cdf4739 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -53,6 +53,13 @@ myConsole.warn(`Danger ${name}! Danger!`); ``` ## Class: Console +<!-- YAML +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/9744 + description: Errors that occur while writing to the underlying streams + will now be ignored. +--> <!--type=class--> diff --git a/doc/api/crypto.md b/doc/api/crypto.md index a36fc7c730..3cec15d822 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1384,6 +1384,9 @@ console.log(hashes); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...] <!-- YAML added: v0.5.5 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/11305 + description: The `digest` parameter is always required now. - version: v6.0.0 pr-url: https://github.com/nodejs/node/pull/4047 description: Calling this function without passing the `digest` parameter diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 65976a85d8..7cac12d5a6 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -249,6 +249,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/5929 description: On success, `callback` will now be called with an `error` argument of `null` rather than `0`. + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10473 + description: The `address` parameter is always optional now. - version: v5.7.0 pr-url: https://github.com/nodejs/node/pull/4374 description: The `msg` parameter can be an array now. Also, the `offset` diff --git a/doc/api/querystring.md b/doc/api/querystring.md index 0c31c1600b..5b913c1a68 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -31,6 +31,9 @@ necessary by assigning `querystring.escape` to an alternative function. <!-- YAML added: v0.1.25 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/10967 + description: Multiple empty entries are now parsed correctly (e.g. `&=&=`). - version: v6.0.0 pr-url: https://github.com/nodejs/node/pull/6055 description: The returned object no longer inherits from `Object.prototype`. diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md index 17bacf33cb..a92f62ebcd 100644 --- a/doc/api/string_decoder.md +++ b/doc/api/string_decoder.md @@ -67,6 +67,11 @@ is performed before returning the remaining input. ### stringDecoder.write(buffer) <!-- YAML added: v0.1.99 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/9618 + description: Each invalid character is now replaced by a single replacement + character instead of one for each individual byte. --> * `buffer` {Buffer} A `Buffer` containing the bytes to decode. |