isNumberBetween()
isNumberBetween()
isNumberBetween()
Checks if any
value is a number
type or an instance of Number
(by using isNumber()
) between a specified range.
Generic type variables
Type
extends
AnyNumber
=
number
Type
extends
AnyNumber
=
number
A generic type variable Type
constrained by AnyNumber
indicates the number type of the given value
via the return type, by default number
.
Min
extends
number
=
number
Min
extends
number
=
number
Max
extends
number
=
number
Max
extends
number
=
number
Payload
extends
object
=
object
Payload
extends
object
=
object
Parameters
value: any
value: any
The value of any
type to check.
min: Min
min: Min
The minimum range of generic type variable Min
for a given value
.
max: Max
max: Max
The maximum range of generic type variable Max
for a given value
.
callback: ResultCallback<any, { min: Min; max: Max } & Payload>
callback: ResultCallback<any, { min: Min; max: Max } & Payload>
payload?: Payload
payload?: Payload
Return type
value is NumberBetween<Min, Max, Type>
value is NumberBetween<Min, Max, Type>
The return type is a boolean
as the result of its statement indicating the value
is a generic type NumberBetween
that takes generic type variables Min
and Max
as a range of the supplied value
and Type
as the type of the supplied value
.
Returns
The return value is a boolean
indicating whether the value
is a finite number
of a number
type or an instance of Number
between a specified range.
Example usage
Type
Instance
Last updated
Was this helpful?