Add Array Iterator global object #35728
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some information about iterators is incomplete.
Patrick-ring-motive
requested review from
Josh-Cena
and removed request for
a team
github-actions
bot
added
Content:JS
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## Description | ||
|
|
||
| The `Array Iterator` is returned by [`Array.prototype.values()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values), [`Array.prototype.keys()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys), [`Array.prototype.entries()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries), [`Array.prototype[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Symbol.iterator), [`TypedArray.prototype.values()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/values), [`TypedArray.prototype.keys()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/keys), [`TypedArray.prototype.entries()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/entries), [`TypedArray.prototype[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/Symbol.iterator), and [`arguments[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Functions/arguments/Symbol.iterator). For [`Arrays`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array), [`[Symbol.iterator]`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Symbol.iterator) is equivalent to [`values`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values). |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| The `Array Iterator` is returned by [`Array.prototype.values()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values), [`Array.prototype.keys()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys), [`Array.prototype.entries()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries), [`Array.prototype[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Symbol.iterator), [`TypedArray.prototype.values()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/values), [`TypedArray.prototype.keys()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/keys), [`TypedArray.prototype.entries()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/entries), [`TypedArray.prototype[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/Symbol.iterator), and [`arguments[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Functions/arguments/Symbol.iterator). For [`Arrays`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array), [`[Symbol.iterator]`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Symbol.iterator) is equivalent to [`values`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values). | |
| The `Array Iterator` is returned by [`Array.prototype.values()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values), [`Array.prototype.keys()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys), [`Array.prototype.entries()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries), [`Array.prototype[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Symbol.iterator), [`TypedArray.prototype.values()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/values), [`TypedArray.prototype.keys()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/keys), [`TypedArray.prototype.entries()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/entries), [`TypedArray.prototype[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/Symbol.iterator), and [`arguments[Symbol.iterator]()`](/en-US/docs/Web/JavaScript/Reference/Functions/arguments/Symbol.iterator). For [`Arrays`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array), [`[Symbol.iterator]`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/Symbol.iterator) is equivalent to [`values`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values). |
Comment on lines
+17
to
+18
|
|
||
| > **Note:** Some Array-Like objects such as [`HTMLCollection`](/en-US/docs/Web/API/HTMLCollection) do not have a reference to the `Array Iterator` object. |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| > **Note:** Some Array-Like objects such as [`HTMLCollection`](/en-US/docs/Web/API/HTMLCollection) do not have a reference to the `Array Iterator` object. | |
| > **Note:** Some Array-Like objects such as [`HTMLCollection`](/en-US/docs/Web/API/HTMLCollection) do not have a reference to the `Array Iterator` object. |
| ## Examples | ||
|
|
||
| #### HTMLCollection Iterator | ||
| Retrieve an `Array Iterator` from Array-Like objects with no iterator methods. This is possible through the use of [`Function.prototype.call()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call) to call array methods on array-like objects. |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| Retrieve an `Array Iterator` from Array-Like objects with no iterator methods. This is possible through the use of [`Function.prototype.call()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call) to call array methods on array-like objects. | |
| Retrieve an `Array Iterator` from Array-Like objects with no iterator methods. This is possible through the use of [`Function.prototype.call()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call) to call array methods on array-like objects. |
|
|
||
| #### HTMLCollection Iterator | ||
| Retrieve an `Array Iterator` from Array-Like objects with no iterator methods. This is possible through the use of [`Function.prototype.call()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call) to call array methods on array-like objects. | ||
| ```js |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| ```js | |
| ```js |
| Retrieve an `Array Iterator` from Array-Like objects with no iterator methods. This is possible through the use of [`Function.prototype.call()`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call) to call array methods on array-like objects. | ||
| ```js | ||
| // Create an HTMLCollection containing all elements in the document | ||
| const collection = document.getElementsByTagName('*'); |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| const collection = document.getElementsByTagName('*'); | |
| const collection = document.getElementsByTagName("*"); |
Comment on lines
+101
to
+106
| const objDefProp = (obj, prop, def) => Object.defineProperty(obj, prop, { | ||
| value: def, | ||
| writable: true, | ||
| enumerable: false, | ||
| configurable: true, | ||
| }); |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| const objDefProp = (obj, prop, def) => Object.defineProperty(obj, prop, { | |
| value: def, | |
| writable: true, | |
| enumerable: false, | |
| configurable: true, | |
| }); | |
| const objDefProp = (obj, prop, def) => | |
| Object.defineProperty(obj, prop, { | |
| value: def, | |
| writable: true, | |
| enumerable: false, | |
| configurable: true, | |
| }); |
| }); | ||
| // Return a copy using the reference array | ||
| return arr.values(); | ||
| } |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| } | |
| }; |
| return arr.values(); | ||
| } | ||
|
|
||
| const arrIter = [1,2,3,4].values(); |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| const arrIter = [1,2,3,4].values(); | |
| const arrIter = [1, 2, 3, 4].values(); |
Comment on lines
+124
to
+125
| console.log([...arrIter]);//[1,2,3,4] | ||
| console.log([...arrIterCopy]);//[1,2,3,4] |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| console.log([...arrIter]);//[1,2,3,4] | |
| console.log([...arrIterCopy]);//[1,2,3,4] | |
| console.log([...arrIter]); //[1,2,3,4] | |
| console.log([...arrIterCopy]); //[1,2,3,4] |
| - {{jsxref("Iterator")}} | ||
| - {{jsxref("Array")}} | ||
| - {{jsxref("Symbol/iterator")}} | ||
|
|
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
|
|
||
| Most [Array-Like](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array#array-like_objects) objects such as [`NodeList`](/en-US/docs/Web/API/NodeList) return an `Array Iterator` from their respective methods `keys()`, `values()`, `entries()`, and `[Symbol.iterator]()`. | ||
|
|
||
| > **Note:** Some Array-Like objects such as [`HTMLCollection`](/en-US/docs/Web/API/HTMLCollection) do not have a reference to the `Array Iterator` object. |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
search-replace Custom rule [gfm-alert: Use the GFM syntax: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#notes_warnings_and_callouts] [Context: "column: 1 text:'> Note:'"]
|
|
||
| ## Constructor | ||
|
|
||
| _Inherits constructor from its ancestor_ |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Inherits constructor from its ..."]
|
|
||
| ## Examples | ||
|
|
||
| #### HTMLCollection Iterator |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
Josh-Cena
reviewed
Sep 3, 2024
There was a problem hiding this comment.
Hi, thanks for the PR! However we don't document every intrinsic: we document only those interesting to developers. This one in particular is not necessary at all to explain how array iteration methods work, so we don't document it.
I understand that you have your own use case that necessitates understanding this, but this is far beyond what MDN strives to document.
|
If you still want to advocate for its documentation, please propose it in https://github.com/mdn/mdn/issues and the team will discuss, but my current position is -1. |
|
No worries. I guess as much but figured I would try. I'll just keep this in my own documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding page for Array Iterator global object
Motivation
This is one of the global objects that could use more illumination. My goal is to provide more information on all the iterators if I can. Need to do some research though because the compatibility tables for these don't match up especially when it comes to Nodejs.
Additional details
The record from the spec.
The entry already in my fork
Related issues and pull requests
Relates to #35598