Class PasswordlessStartError

Thrown when initiating a passwordless flow via /passwordless/start fails.

Common causes:

Connection not enabled for the application
Missing or invalid email / phone number
Rate limit exceeded on send

Hierarchy

PasswordlessError
- PasswordlessStartError

Index

Constructors

Properties

cause? error error_description

Accessors

Methods

Constructors

constructor

new PasswordlessStartError(
    error: string,
    error_description: string,
    cause?: PasswordlessApiErrorResponse,
): PasswordlessStartError
Parameters
- error: string
- error_description: string
- Optionalcause: PasswordlessApiErrorResponse
Returns PasswordlessStartError
Overrides PasswordlessError.constructor
- Defined in src/errors/passwordless-errors.ts:51

Properties

`Optional` `Readonly`cause

cause?: PasswordlessApiErrorResponse

`Readonly`error

error: string

`Readonly`error_description

error_description: string

Accessors

code

get code(): string
Returns string
Overrides PasswordlessError.code
- Defined in src/errors/passwordless-errors.ts:47

Methods

toJSON

toJSON(): { error: string; error_description: string }
Returns { error: string; error_description: string }
Inherited from PasswordlessError.toJSON
- Defined in src/errors/passwordless-errors.ts:24