isNumberBetween()
Last updated
Was this helpful?
Last updated
Was this helpful?
isNumberBetween()
Checks if value is a type or an instance of (by using ) between a specified range.
Type
extends
AnyNumber
=
number
Min
extends
number
=
number
Max
extends
number
=
number
Payload
extends
object
=
object
value: any
min: Min
max: Max
callback: ResultCallback<any, { min: Min; max: Max } & Payload>
payload?: Payload
value is NumberBetween<Min, Max, Type>
A generic type variable Type
constrained by indicates the number type of the given via the , by default .
A generic type variable Min
constrained by the type, by default of value captured from the supplied indicates the minimum range of the provided via the and the fixed shape of optional parameter of the provided function.
A generic type variable Max
constrained by the type, by default of value captured from the supplied indicates the maximum range of the provided via the and the fixed shape of optional parameter of the provided function.
The Payload
generic type variable constrained by indicates the type of optional parameter of the supplied function and optional parameter of the function from which it captures its value.
The value of type to check.
The minimum range of generic type variable for a given .
The maximum range of generic type variable for a given .
A callback function
of type with parameters, the that has been checked, the of this check, and of generic type variable with optional properties from the provided , to handle them before the return. By default, it uses function.
The parameter of the function consists of the and properties given in parameters of the core function, and they can't be overwritten by the given parameter of the core function.
An optional of the generic type variable is assigned to the of the given function.
The return type is a as the result of its statement indicating the is a generic type that takes generic type variables and as a range of the supplied and as the type of the supplied .
The return value is a indicating whether the is a finite of a type or an instance of between a specified range.