Clarify usage of return values in iterator protocol

[etrepum]

Description

There's an example with an iterable that returns an iterator that enumerates 1, 2, and returns with {done: true, value: 3}, and is evaluated with const [b, c, d] = obj.

It takes a careful reading to notice that the third value is used only to ensure that the iterator is exhausted and that the value from the iterator return is not bound to d.

Motivation

Since the example is "Returning 3" in the comment above when next() returns {done:true, value: 3} a reader may think that 3 is bound to d in this case. With this comment, it will be easier to see that the value returned by an exhausted iterator is not used in any normal scenario, including array destructuring.

Additional details

N/A

Related issues and pull requests

N/A

[github-actions]

Preview URLs

• /en-US/docs/Web/JavaScript/Reference/Iteration_protocols

Flaws (6)

URL: /en-US/docs/Web/JavaScript/Reference/Iteration_protocols
Title: Iteration protocols
Flaw count: 6

• macros:
  • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
  • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
  • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
  • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
  • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks
  • and 1 more flaws omitted

(comment last updated: 2025-01-06 16:47:41)

[Josh-Cena]

Thanks!