diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 08756bb9ca23ae..0e1074a81854d0 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -5281,10 +5281,12 @@ An alias for [`buffer.constants.MAX_STRING_LENGTH`][]. -> Stability: 1 - Experimental - * `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`. * Returns: {Blob} diff --git a/doc/api/fs.md b/doc/api/fs.md index 98eb92b740c299..78618afa43c4f3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -481,6 +481,9 @@ number of bytes read is zero. -> Stability: 1 - Experimental - * Returns: {ReadableStream} Returns a byte-oriented `ReadableStream` that may be used to read the file's @@ -1074,6 +1075,9 @@ behavior is similar to `cp dir1/ dir2/`. -> Stability: 1 - Experimental - * `pattern` {string|string\[]} * `options` {Object} * `cwd` {string} current working directory. **Default:** `process.cwd()` @@ -3132,6 +3134,9 @@ descriptor. See [`fs.utimes()`][]. -> Stability: 1 - Experimental - * `pattern` {string|string\[]} * `options` {Object} @@ -3583,10 +3586,12 @@ Functions based on `fs.open()` exhibit this behavior as well: -> Stability: 1 - Experimental - * `path` {string|Buffer|URL} * `options` {Object} * `type` {string} An optional mime type for the blob. @@ -5682,6 +5687,9 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`. -> Stability: 1 - Experimental - * `pattern` {string|string\[]} * `options` {Object} * `cwd` {string} current working directory. **Default:** `process.cwd()` @@ -6837,10 +6843,12 @@ added: - v21.4.0 - v20.12.0 - v18.20.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * {string} The path to the parent directory of the file this {fs.Dirent} object refers to. diff --git a/doc/api/readline.md b/doc/api/readline.md index ff3e572058ffcf..5cf2d52e22f9c9 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -500,10 +500,12 @@ line prompts are included in the calculations. -> Stability: 1 - Experimental - ### Class: `readlinePromises.Interface` -> Stability: 1 - Experimental - * {boolean} Returns whether the stream was destroyed or errored before emitting `'finish'`. @@ -1641,10 +1643,12 @@ the stream has not been destroyed or emitted `'error'` or `'end'`. -> Stability: 1 - Experimental - * {boolean} Returns whether the stream was destroyed or errored before emitting `'end'`. @@ -1655,10 +1659,12 @@ Returns whether the stream was destroyed or errored before emitting `'end'`. added: - v16.7.0 - v14.18.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * {boolean} Returns whether `'data'` has been emitted. @@ -2003,10 +2009,12 @@ a promise that fulfills when the stream is finished. added: - v19.1.0 - v18.13.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `stream` {Stream|Iterable|AsyncIterable|Function} * `options` {Object} * `signal` {AbortSignal} allows destroying the stream if the signal is @@ -2038,10 +2046,12 @@ See [`stream.compose`][] for more information. -> Stability: 1 - Experimental - * `options` {Object} * `destroyOnReturn` {boolean} When set to `false`, calling `return` on the async iterator, or exiting a `for await...of` iteration using a `break`, @@ -3079,10 +3089,12 @@ Readable.from([ -> Stability: 1 - Experimental - * `readableStream` {ReadableStream} * `options` {Object} * `encoding` {string} @@ -3095,10 +3107,12 @@ added: v17.0.0 -> Stability: 1 - Experimental - * `stream` {stream.Readable|ReadableStream} * Returns: `boolean` @@ -3110,10 +3124,12 @@ Returns whether the stream has been read from or cancelled. added: - v17.3.0 - v16.14.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream} * Returns: {boolean} @@ -3125,10 +3141,12 @@ Returns whether the stream has encountered an error. added: - v17.4.0 - v16.14.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `stream` {Readable|Duplex|ReadableStream} * Returns: {boolean} @@ -3139,14 +3157,15 @@ Returns whether the stream is readable. -> Stability: 1 - Experimental - * `streamReadable` {stream.Readable} * `options` {Object} * `strategy` {Object} @@ -3164,10 +3183,12 @@ changes: -> Stability: 1 - Experimental - * `writableStream` {WritableStream} * `options` {Object} * `decodeStrings` {boolean} @@ -3180,10 +3201,12 @@ added: v17.0.0 -> Stability: 1 - Experimental - * `streamWritable` {stream.Writable} * Returns: {WritableStream} @@ -3242,10 +3265,12 @@ Duplex.from([ -> Stability: 1 - Experimental - * `pair` {Object} * `readable` {ReadableStream} * `writable` {WritableStream} @@ -3323,10 +3348,12 @@ duplex.once('readable', () => console.log('readable', duplex.read())); -> Stability: 1 - Experimental - * `streamDuplex` {stream.Duplex} * Returns: {Object} * `readable` {ReadableStream} diff --git a/doc/api/url.md b/doc/api/url.md index f6913bc688032c..7a4bece9a48a0b 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -628,10 +628,12 @@ console.log(JSON.stringify(myURLs)); -> Stability: 1 - Experimental - * `blob` {Blob} * Returns: {string} @@ -664,10 +666,12 @@ to other workers or the main thread. -> Stability: 1 - Experimental - * `id` {string} A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`. diff --git a/doc/api/v8.md b/doc/api/v8.md index 37099594a2f18c..dd1139b1c1adb4 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -580,10 +580,12 @@ if (isMainThread) { added: - v18.10.0 - v16.18.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * `limit` {integer} The API is a no-op if `--heapsnapshot-near-heap-limit` is already set from the @@ -1116,10 +1118,12 @@ occur synchronously in the case of `Promise.resolve()` or `Promise.reject()`. added: - v18.6.0 - v16.17.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - The `v8.startupSnapshot` interface can be used to add serialization and deserialization hooks for custom startup snapshots. diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 20ce83be81782d..e9219bbea0d6e5 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -995,10 +995,12 @@ port2.postMessage(new URL('https://example.org')); added: - v18.1.0 - v16.17.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/57513 + description: Marking the API stable. --> -> Stability: 1 - Experimental - * Returns: {boolean} If true, the `MessagePort` object will keep the Node.js event loop active.