diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-06-25 20:18:36 +0300 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-06-27 20:51:51 +0300 |
| commit | d22fbbe94246d5363ea17c29d8cd5c3b9ca8125b (patch) | |
| tree | e6d09b697aa0aaf7c43f6affa10fa828536c542a /doc/api/readline.md | |
| parent | fd3a0d313757a27d7ed52a9cc3afde0fcc485268 (diff) | |
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: https://github.com/nodejs/node/pull/28425
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
| -rw-r--r-- | doc/api/readline.md | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 1131438eb50..1e1861c1ab6 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -318,8 +318,6 @@ changes: description: Symbol.asyncIterator support is no longer experimental. --> -> Stability: 2 - Stable - * Returns: {AsyncIterator} 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`, [`rl.close()`][] will be called. In other words, iterating over a `readline.Interface` will always consume the input stream fully. -A caveat with using this experimental API is that the performance is -currently not on par with the traditional `'line'` event API, and thus it is -not recommended for performance-sensitive applications. We expect this -situation to improve in the future. +Performance is not on par with the traditional `'line'` event API. Use `'line'` +instead for performance-sensitive applications. ```js async function processLineByLine() { |