Documentation

Documentation / @zerotal/auth / PasswordBrokerOptions

Interface: PasswordBrokerOptions

Defined in: auth/src/PasswordBroker.ts:38

Properties

expireMinutes?

optional expireMinutes?: number

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

Minutes until a reset token expires. Default: 60.

Methods

findToken()

findToken(email): Promise<{ token: string; createdAt: Date; } | null>

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

Parameters

email

string

Returns

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

storeToken()

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

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

Parameters

email

string

hash

string

expiresAt

Date

Returns

Promise<void>

deleteToken()

deleteToken(email): Promise<void>

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

Parameters

email

string

Returns

Promise<void>

pruneTokens()

pruneTokens(cutoff): Promise<void>

Defined in: auth/src/PasswordBroker.ts:44

Parameters

cutoff

Date

Returns

Promise<void>

sendResetLink()

sendResetLink(email, token): Promise<void>

Defined in: auth/src/PasswordBroker.ts:45

Parameters

email

string

token

string

Returns

Promise<void>

resetPassword()

resetPassword(email, newPassword): Promise<void>

Defined in: auth/src/PasswordBroker.ts:46

Parameters

email

string

newPassword

string

Returns

Promise<void>