guardNumberBetween()
Last updated
Was this helpful?
Last updated
Was this helpful?
guardNumberBetween()
Guards the value to be type or instance of between the specified range.
Code on .
Type
extends
AnyNumber
Min
extends
number
Max
extends
number
Payload
extends
object
=
object
value: Type
min: Min
max: Max
callback?: ResultCallback<Type, { min: Min; max: Max } & Payload>
payload?: Payload
value is NumberBetween<Min, Max, Type>
A generic type variable Type
constrained by generic type indicates captured type of the supplied via the and the parameter of the provided function type.
A generic type variable Min
constrained by the type, by default of value captured from the supplied indicates the fixed shape parameter type of the provided function type and the minimum range of the provided via the .
A generic type variable Max
constrained by the type, by default of value captured from the supplied indicates the fixed shape parameter type of the provided function type and the maximum range of the provided via the .
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 generic type variable to guard.
The minimum range of generic type variable for a given .
The maximum range of generic type variable for a given .
The optional callback of type with parameters, the that has been checked, the result
of this check, and payload
of generic type variable with optional properties from the provided payload
, to handle them before the result
return. By default, it uses function.
The parameter of the function consists of the min
and max
properties of the given and parameters, and they can't be overwritten by the given parameter of the main 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 type or an instance of between the specified range.