fix: KeyboardLayoutMap.keys/values/entries should have methods type

[skyclouds2001]

Description

Motivation

note that KeyboardLayoutMap is a map-like object, see https://wicg.github.io/keyboard-map/#keyboardlayoutmap-interface, and KeyboardLayoutMap.entries() KeyboardLayoutMap.keys() KeyboardLayoutMap.values() are methods instead of properties

a example is below

navigator.keyboard.getLayoutMap().then((layout) => {
  for (const l of layout.entries()) {
    console.log(l)
  }
})

Additional details

Working on https://developer.mozilla.org/en-US/docs/Web/API/KeyboardLayoutMap
Related with https://wicg.github.io/keyboard-map/

Related issues and pull requests

Relates to #6891

[github-actions]

Preview URLs (8 pages)

• /en-US/docs/Web/API/KeyboardLayoutMap/entries
• /en-US/docs/Web/API/KeyboardLayoutMap/forEach
• /en-US/docs/Web/API/KeyboardLayoutMap/get
• /en-US/docs/Web/API/KeyboardLayoutMap/has
• /en-US/docs/Web/API/KeyboardLayoutMap/keys
• /en-US/docs/Web/API/KeyboardLayoutMap/size
• /en-US/docs/Web/API/KeyboardLayoutMap/values
• /en-US/docs/Web/API/KeyboardLayoutMap

(comment last updated: 2023-12-09 13:31:20)

[wbamberg]

Thank you for the PR, @skyclouds2001 ! But there's more work needed in here. Changing the page type is good, but the page itself is written as if this is a property (e.g. it's described as a property, it doesn't have "Parameters" or "Return value", etc.).

Note that it's a bit unsettled how we should document members of maplike and setlike interfaces: sometimes we document the methods and properties fully (e.g. https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport/entries), sometimes we just list them in the interface main page and link to the Map/Set object (e.g. https://developer.mozilla.org/en-US/docs/Web/API/EventCounts).

openwebdocs/project#159 is supposed to help resolve this but it's not ready yet.

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/map#map-like_browser_apis is also a helpful page to link to in places like this :).

[teoli2003]

@skyclouds2001 This is a great catch and essential work, long due! Thank you!

As this PR defines the page structure for these maplike members, it is essential to take some time to carefully review them, as these structures will be reused for the 5-6 other such interfaces (that need them). That way, we won't do this work each time.

A few additions that I would like to see:

• Adding a spec-url entry in the FrontMatter YAML, like for Hightlight.entries() – Hightlight is a set-like object – that links to the Set.entries() definition. Same for all other pages, to their relevant definitions, of course. Ultimately, we should store it in BCD, but I don't see a need to couple both discussions – I know there is no consensus between BCD peers 😉 – and hold this PR more than necessary.
• An example for each method. They will be similar, except in how the object is created. Highlight's methods have most of them written and are a good place to start.

Once this PR is merged, I think we should update the meta-documentation for these setlike and maplike pages, so we can refer writers when new such interfaces have to be added.

I'm really excited about this work. Thanks a lot for tackling this.

[teoli2003]

This looks good to me. @skyclouds2001 Do you want to update the other set-like and map-like interfaces with similar pages?

If you want, I can prepare an issue with the list of such interfaces.

[skyclouds2001]

This looks good to me. @skyclouds2001 Do you want to update the other set-like and map-like interfaces with similar pages?

If you want, I can prepare an issue with the list of such interfaces.

I'd love to do it!