isArray()
isArray()
isArray()
Checks if any
value is of the type obtained from its object
class equal to 'array'
or an object
type and passes the test Array.isArray()
method.
Generic type variables
Type
=
any
Type
=
any
The Type
generic type variable indicates the array
element type of the given value
via the return type, by default is any
.
Payload
extends
object
=
object
Payload
extends
object
=
object
The Payload
generic type variable constrained by object
indicates the type of optional parameter payload
of the supplied callback
function and payload
optional parameter of the isArray()
function from which it captures its value.
Parameters
value: any
value: any
The value of any
type to check.
callback: ResultCallback<any, Payload>
callback: ResultCallback<any, Payload>
A callback function
of ResultCallback
type with parameters, the value
that has been checked, the result
of this check, and payload
of generic type variable Payload
with optional properties from the provided payload
, to handle them before the result
return. By default, it uses resultCallback()
function.
payload?: Payload
payload?: Payload
An optional object
of the generic type variable Payload
is assigned to the payload
of the given callback
function.
Return type
value is Array<Type>
value is Array<Type>
The return type is a boolean
because of used the is
operator indicating the value is an array
that takes generic type variable Type
by default of value any
as the type of its elements.
Returns
The return value is a boolean
indicating whether the provided value
is an Array
.
Example usage
Basic example
Fake array
array
Parameters callback
and payload
callback
and payload
Last updated