XRInputSourceArray: keys() 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 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
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
This feature does not appear to be defined in any specification.Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
keys
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
See also
- Inputs and input sources
- The
XRInputSourceArraymethodvalues() - The
Arraymethodkeys() XRInputSource