API Reference
Rockets Core API
ts-common
interfaces
OtpValidateInterface

Interface: OtpValidateInterface<O>

Type Parameters

Type ParameterDefault type
O extends ReferenceQueryOptionsInterfaceReferenceQueryOptionsInterface

Methods

validate()

validate(assignment, otp, deleteIfValid, options?): Promise<null | ReferenceAssigneeInterface<ReferenceIdInterface<string>>>

Check if otp is valid

Parameters

ParameterTypeDescription
assignmentstringThe otp assignment
otpPick<OtpInterface, "category" | "passcode">The otp to validate
deleteIfValidbooleanIf true, delete the otp if it is valid
options?O-

Returns

Promise<null | ReferenceAssigneeInterface<ReferenceIdInterface<string>>>

Defined in

ts-common/src/otp/interfaces/otp-validate.interface.ts:18 (opens in a new tab)