Commit 3fea2e4
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 <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 0d2d116 commit 3fea2e4
1 file changed
Lines changed: 2 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -318,8 +318,6 @@ changes: | |||
| 318 | 318 | description: Symbol.asyncIterator support is no longer experimental. | |
| 319 | 319 | --> | |
| 320 | 320 | ||
| 321 | - > Stability: 2 - Stable | ||
| 322 | - | ||
| 323 | 321 | * Returns: {AsyncIterator} | |
| 324 | 322 | ||
| 325 | 323 | 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`, | |||
| 332 | 330 | [`rl.close()`][] will be called. In other words, iterating over a | |
| 333 | 331 | `readline.Interface` will always consume the input stream fully. | |
| 334 | 332 | ||
| 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. | ||
| 339 | 335 | ||
| 340 | 336 | ```js | |
| 341 | 337 | async function processLineByLine() { | |
0 commit comments