Class: AccessibleUtils
Defined in: src/sdk/sub/AccessibleUtils.ts:7
A utility class for working with Accessibles.
Constructors
Constructor
new AccessibleUtils():
AccessibleUtils
Returns
AccessibleUtils
Methods
isAccessible()
static
isAccessible<T
>(query
):query is Accessible<T>
Defined in: src/sdk/sub/AccessibleUtils.ts:13
Checks if a query is an accessible.
Type Parameters
Type Parameter | Default type |
---|---|
T | any |
Parameters
Parameter | Type | Description |
---|---|---|
query | unknown | A query. |
Returns
query is Accessible<T>
Whether the query is an accessible.
isMutableAccessible()
static
isMutableAccessible<T
,I
>(query
):query is MutableAccessible<T, I>
Defined in: src/sdk/sub/AccessibleUtils.ts:26
Checks if a query is a mutable accessible.
Type Parameters
Type Parameter | Default type |
---|---|
T | any |
I | T |
Parameters
Parameter | Type | Description |
---|---|---|
query | unknown | A query. |
Returns
query is MutableAccessible<T, I>
Whether the query is a mutable accessible.
toAccessible()
static
toAccessible<V
,Exclude
>(value
,excludeAccessibles
):Exclude
extendstrue
?V
extendsAccessible
<any
> ?V
<V
> :Accessible
<V
> :Accessible
<V
>
Defined in: src/sdk/sub/AccessibleUtils.ts:44
Converts a value to an accessible.
If the excludeAccessibles
argument is true
and the value is already an accessible, then the value is returned
unchanged. Otherwise, a new accessible whose state is always equal to the value will be created and returned.
Type Parameters
Type Parameter |
---|
V |
Exclude extends boolean |
Parameters
Parameter | Type | Description |
---|---|---|
value | V | The value to convert to an accessible. |
excludeAccessibles | Exclude | Whether to return accessible values as-is instead of wrapping them in another accessible. |
Returns
Exclude
extends true
? V
extends Accessible
<any
> ? V
<V
> : Accessible
<V
> : Accessible
<V
>
An accessible.