guardBoolean()
Last updated
Was this helpful?
Last updated
Was this helpful?
guardBoolean()
Guards the value to be boolean
of any type.
Type
extends
AnyBoolean
A generic type variable Type
constrained by generic type AnyBoolean
indicates captured boolean
type of the given value
via the return type and the parameter of the provided callback
function ResultCallback
type.
Payload
extends
object
=
object
The Payload
generic type variable constrained by object
indicates the type of optional parameter of the supplied callback
function and payload
optional parameter of the guardBoolean()
function from which it captures its value.
value: Type
The value of generic type variable Type
to guard.
callback?: ResultCallback<bigint, Payload>
payload?: Payload
value is Type
The return type is a boolean
as the result of its statement indicating the value
is a generic type variable Type
by default of type captured from the supplied value
.
The return value is a boolean
indicating whether the value
is a boolean
type or an instance of Boolean
.
The optional callback function
of ResultCallback
type with parameters, the value
that has been checked, the of this check, and 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.