providers/loops

Built-in Loops integration.

LoopsConfig

Extends

• Omit<EmailConfig, "sendVerificationRequest" | "options">

Properties

apiKey

apiKey: string;

Used with HTTP-based email providers.

Overrides

Omit.apiKey

from?

optional from: string;

Inherited from

Omit.from

generateVerificationToken()?

optional generateVerificationToken: () => Awaitable<string>;

Returns

Awaitable<string>

Inherited from

Omit.generateVerificationToken

id

id: string;

Overrides

Omit.id

maxAge?

optional maxAge: number;

Inherited from

Omit.maxAge

name

name: string;

The provider name used on the default sign-in page’s sign-in button. For example if it’s “Google”, the corresponding button will say: “Sign in with Google”

Inherited from

Omit.name

normalizeIdentifier()?

optional normalizeIdentifier: (identifier) => string;

Parameters

Returns

string

Inherited from

Omit.normalizeIdentifier

options

options: LoopsUserConfig;

secret?

optional secret: string;

Used to hash the verification token.

Inherited from

Omit.secret

sendVerificationRequest()

sendVerificationRequest: (params) => Promise<void>;

Parameters

Returns

Promise<void>

server?

optional server: AllTransportOptions;

Used with SMTP-based email providers.

Inherited from

Omit.server

transactionalId

transactionalId: string;

type

type: "email";

See ProviderType

Inherited from

Omit.type

LoopsUserConfig

type LoopsUserConfig = Omit<Partial<LoopsConfig>, "options" | "type">;

default()

function default(config): LoopsConfig

Parameters

Returns

LoopsConfig

LoopsConfig

Requires

LoopsUserConfig

Example

Loops({
  apiKey: process.env.AUTH_LOOPS_KEY,
  transactionalId: process.env.AUTH_LOOPS_TRANSACTIONAL_ID,
})