Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: unify format of iterables #20036

Closed
wants to merge 1 commit into from
Closed

doc: unify format of iterables #20036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1206,16 +1206,14 @@ myReader.on('readable', () => {
});
```

##### readable[@@asyncIterator]
##### readable\[Symbol.asyncIterator\]()
<!-- YAML
added: REPLACEME
-->

> Stability: 1 - Experimental
* {AsyncIterator}

Returns an [AsyncIterator][async-iterator] to fully consume the stream.
* Returns: {AsyncIterator} to fully consume the stream.

```js
const fs = require('fs');
Expand Down Expand Up @@ -2415,4 +2413,3 @@ contain multi-byte characters.
[readable-destroy]: #stream_readable_destroy_error
[writable-_destroy]: #stream_writable_destroy_err_callback
[writable-destroy]: #stream_writable_destroy_error
[async-iterator]: https://github.com/tc39/proposal-async-iteration
4 changes: 2 additions & 2 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,7 @@ percent-encoded where necessary.

Returns an ES6 Iterator over the values of each name-value pair.

#### urlSearchParams\[@@iterator\]()
#### urlSearchParams\[Symbol.iterator\]()

* Returns: {Iterator}

Expand Down Expand Up @@ -1174,7 +1174,7 @@ console.log(myURL.origin);
[`url.toJSON()`]: #url_url_tojson
[`url.toString()`]: #url_url_tostring
[`urlSearchParams.entries()`]: #url_urlsearchparams_entries
[`urlSearchParams@@iterator()`]: #url_urlsearchparams_iterator
[`urlSearchParams@@iterator()`]: #url_urlsearchparams_symbol_iterator
[ICU]: intl.html#intl_options_for_building_node_js
[Punycode]: https://tools.ietf.org/html/rfc5891#section-4.4
[WHATWG URL Standard]: https://url.spec.whatwg.org/
Expand Down