guardKey()
Last updated
Was this helpful?
Last updated
Was this helpful?
guardKey()
Guards the value to be one of , , or type.
Code on .
Key
extends
PropertyKey
A generic type variable Key
constrained by PropertyKey
indicates captured type of the given via the and the parameter of the provided function type.
Payload
extends
object
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.
value: Key
callback?: ResultCallback<Key, Payload>
payload?: Payload
value is Key
The value of generic type variable to guard.
The optional callback 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.
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 generic type variable .
The return value is a indicating whether the is a , , or .