URLSearchParams.prototype[@@iterator]() is missing

[fisker]

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/URLSearchParams

What specific section or headline is this issue about?

No response

What information was incorrect, unhelpful, or incomplete?

Should add a page for it like Map.prototype[@@iterator]()

What did you expect to see?

Documentation for URLSearchParams.prototype[@@iterator]().

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

[Josh-Cena]

Web APIs do not document well-known symbols because they are implementation details. The landing page already explicitly documents that it's iterable, so I think this is all good and follows our guidelines. We may make all of this more structured in the future; see openwebdocs/project#159

[fisker]

Kind of miss leading that there is no @@iterator on left side under Instance methods. I thought it's not iterable...

[Josh-Cena]

Web APIs in general tend to be more high-level and focus on the majority of use cases. For example, we may assume that an average developer neither knows what @@iterator means nor how an iterable object should be iterated, so spelling it out on the landing page is perhaps more pragmatic.

[fisker]

Good to know, I'll try to read the text instead of search for @@iterator next time. 😄

[fisker]

@Josh-Cena A off topic question.

Unlike @@iterator it's normally simple enough to explain with a code block, the up coming @@dispose may need a page to explain what have done for complex web stuff. Will we consider document it in future? (Since you said "Web APIs do not document well-known symbols")

[Josh-Cena]

That's a good question! My feeling is that we don't usually worry about cleanup logic to start with, so maybe not. At most we would have an example saying "you should probably use using so it gets properly cleaned up". But I'm not a web API author and the decision is far from finalized, so don't take my word for it 😄

[fisker]

Thank you!