Skip to main content
zerotal

Documentation

Documentation / @zerotal/auth / MagicLinkBrokerOptions

Interface: MagicLinkBrokerOptions<U>

Defined in: auth/src/MagicLinkBroker.ts:37

Type Parameters

U

U extends MagicLinkUser = MagicLinkUser

Properties

secret

secret: string

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

App secret used to sign links -- use the same value as session.secret / APP_KEY.

verifyUrl

verifyUrl: string

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

The absolute URL the signed link will point to (your verify endpoint).

expiresInMinutes?

optional expiresInMinutes?: number

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

Minutes until the link expires. Default: 15.

Methods

findUser()

findUser(email): Promise<U | null | undefined>

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

Parameters

email

string

Returns

Promise<U | null | undefined>

sendLink(email, signedUrl): Promise<void>

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

Parameters

email

string

signedUrl

string

Returns

Promise<void>