KeyboardLayoutMap: forEach() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The forEach() method of the KeyboardLayoutMap interface executes a provided function once for each element of the map.

The method is otherwise the same as Map.prototype.forEach().

Syntax

forEach(callbackFn)
forEach(callbackFn, thisArg)

Parameters

callbackFn

The function to execute for each element, taking three arguments:

currentValue: The value of the current element being processed.
index Optional: The index of the current element being processed.
array Optional: The KeyboardLayoutMap that forEach() is being called on.

thisArg Optional

Value to use as this (i.e., the reference Object) when executing callback.

Return value

None (undefined).

Examples

The following example iterates every location- or layout-specific string and its associated keyboard code on an English QWERTY keyboard.

navigator.keyboard.getLayoutMap().then((keyboardLayoutMap) => {
  keyboardLayoutMap.forEach((key, code) => {
    console.log(`${code} keyboard code represents ${key} key`);
  });
});