Skip to content

Commit 3fea2e4

Browse files
cjihrigtargos
authored andcommitted
doc: update readline asyncIterator docs
This commit: - Removes an unnecessary stability index entry. These generally are not included for Stable entries. - Remove mention of experimental status that is not true anymore. - Remove use of "we" - Remove use of relative time phrasing. - Misc cleanup. PR-URL: #28425 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 0d2d116 commit 3fea2e4

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

doc/api/readline.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -318,8 +318,6 @@ changes:
318318
description: Symbol.asyncIterator support is no longer experimental.
319319
-->
320320

321-
> Stability: 2 - Stable
322-
323321
* Returns: {AsyncIterator}
324322

325323
Create an `AsyncIterator` object that iterates through each line in the input
@@ -332,10 +330,8 @@ If the loop is terminated with `break`, `throw`, or `return`,
332330
[`rl.close()`][] will be called. In other words, iterating over a
333331
`readline.Interface` will always consume the input stream fully.
334332

335-
A caveat with using this experimental API is that the performance is
336-
currently not on par with the traditional `'line'` event API, and thus it is
337-
not recommended for performance-sensitive applications. We expect this
338-
situation to improve in the future.
333+
Performance is not on par with the traditional `'line'` event API. Use `'line'`
334+
instead for performance-sensitive applications.
339335

340336
```js
341337
async function processLineByLine() {

0 commit comments

Comments
 (0)