Interface: OtpValidateInterface<O>
Type Parameters
Type Parameter | Default type |
---|---|
O extends ReferenceQueryOptionsInterface | ReferenceQueryOptionsInterface |
Methods
validate()
validate(
assignment
,otp
,deleteIfValid
,options
?):Promise
<null
|ReferenceAssigneeInterface
<ReferenceIdInterface
<string
>>>
Check if otp is valid
Parameters
Parameter | Type | Description |
---|---|---|
assignment | string | The otp assignment |
otp | Pick <OtpInterface , "category" | "passcode" > | The otp to validate |
deleteIfValid | boolean | If 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)