Interface VerificationOptions<TUser>

The VerificationManager options.

Export

VerificationOptions

interface VerificationOptions<TUser> {
    codeGenerationOptions: {
        charactersWhitelist?: string;
        length: number;
    };
    maxNbCodeCalledBeforeResend: number;
    alreadyActiveMessage(user): string;
    alreadyPendingMessage(user): string;
    errorMessage(user, error): string;
    invalidCodeMessage(user, invalidCode): string;
    pendingMessage(user): string;
    validCodeMessage(user, validCode): string;
}

Type Parameters

TUser extends IUser

Index

Properties

codeGenerationOptions maxNbCodeCalledBeforeResend

Methods

alreadyActiveMessage alreadyPendingMessage errorMessage invalidCodeMessage pendingMessage validCodeMessage

Properties

codeGenerationOptions

codeGenerationOptions: {
charactersWhitelist?: string;
length: number;
}

The options related to the code generation.

Type declaration

Optional charactersWhitelist?: string
The whitelist of characters used to generate the code.
length: number
The required length of the code.

Memberof

VerificationOptions

maxNbCodeCalledBeforeResend

maxNbCodeCalledBeforeResend: number

The maximum number of calls before resending the code to the user via the communication service.

Memberof

VerificationOptions

Methods

alreadyActiveMessage

alreadyActiveMessage(user): string
Formats the message sent once the user tries to generate a code when they are already verified.
Parameters
- user: TUser
Returns string
the message

Memberof
VerificationOptions
- Defined in types/VerificationOptions.ts:79

alreadyPendingMessage

alreadyPendingMessage(user): string
Formats the message sent once the user tries to generate a code when it's already sent to them.
Parameters
- user: TUser
Returns string
the message

Memberof
VerificationOptions
- Defined in types/VerificationOptions.ts:70

errorMessage

errorMessage(user, error): string
Formats the message sent when calling the communication service throws an error.
Parameters
- user: TUser
- error: unknown
Returns string
the message

Memberof
VerificationOptions
- Defined in types/VerificationOptions.ts:52

invalidCodeMessage

invalidCodeMessage(user, invalidCode): string
Formats the message sent once the code is checked and invalid.
Parameters
- user: undefined | null | TUser
- invalidCode: string
Returns string
the message

Memberof
VerificationOptions
- Defined in types/VerificationOptions.ts:99

pendingMessage

pendingMessage(user): string
Formats the message sent for the first time when the user's code has just been sent.
Parameters
- user: TUser
Returns string
the message

Memberof
VerificationOptions
- Defined in types/VerificationOptions.ts:61

validCodeMessage

validCodeMessage(user, validCode): string
Formats the message sent once the code is checked and valid.
Parameters
- user: undefined | null | TUser
- validCode: string
Returns string
the message

Memberof
VerificationOptions
- Defined in types/VerificationOptions.ts:89