Web/API/XRInputSourceArray/keys

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The keys() method in the XRInputSourceArray interface returns a JavaScript iterator which can then be used to iterate over the keys used to reference each item in the array of input sources.

Syntax

xrInputSourceArray.keys();

Parameters

None.

Return value

A JavaScript iterator that can be used to walk through the keys for each entry in the list of input sources. The values returned by the iterator are the indexes of each entry in the list; that is, the numbers 0, 1, 2, and so forth through the index of the last item in the list.

Examples

This example snippet gets the list of inputs for a session and tries to handle each type of input device it supports using.

for (const inputIdx of xrSession.inputSources.keys()) {
  /* the keys are the indexes into the list of inputs */
  checkInput(xrSession.inputSources[inputIdx]);
}

Here, for...of is used to iterate over each of the keys. For each key, the input is retrieved using the index with array notation: xrSession.inputSources[inputIdx].

Specifications

Specification	Status	Comment
WebXR Device APIThe definition of 'XRInputSourceArray' in that specification.¹	Working Draft	`XRInputSourceArray` interface

[1] See [[../../../../MDN/Contribute/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file#Iterator-like_methods|Iterator-like methods]] in [[../../../../MDN/Contribute/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file|Information contained in a WebIDL file]] for information on how an iterable declaration in an interface definition causes entries(), forEach(), keys(), and values() methods to be exposed from objects that implement the interface.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`keys`	Chrome Full support 79	Edge Full support 79	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android No support No	Chrome Android Full support 79	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support 11.2

Legend

Full support: Full support
No support: No support