Documentation

Documentation / @zerotal/auth / EmailOtpOptions

Interface: EmailOtpOptions

Defined in: auth/src/EmailOtpBroker.ts:29

Properties

expireMinutes?

optional expireMinutes?: number

Defined in: auth/src/EmailOtpBroker.ts:31

Minutes a code stays valid. Default 10.

length?

optional length?: number

Defined in: auth/src/EmailOtpBroker.ts:33

Number of digits in the code. Default 6.

maxAttempts?

optional maxAttempts?: number

Defined in: auth/src/EmailOtpBroker.ts:39

Failed verification attempts allowed before the code is invalidated. Default 5. Keeps a short numeric code from being brute-forced inside its expiry window.

Methods

findCode()

findCode(email): Promise<{ code: string; createdAt: Date; } | null>

Defined in: auth/src/EmailOtpBroker.ts:40

Parameters

email

string

Returns

Promise<{ code: string; createdAt: Date; } | null>

storeCode()

storeCode(email, hash, expiresAt): Promise<void>

Defined in: auth/src/EmailOtpBroker.ts:41

Parameters

email

string

hash

string

expiresAt

Date

Returns

Promise<void>

deleteCode()

deleteCode(email): Promise<void>

Defined in: auth/src/EmailOtpBroker.ts:42

Parameters

email

string

Returns

Promise<void>

sendCode()

sendCode(email, code): Promise<void>

Defined in: auth/src/EmailOtpBroker.ts:43

Parameters

email

string

code

string

Returns

Promise<void>