errors

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "AccessDenied";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

AccountNotLinked

Thrown when an Email address is already associated with an account but the user is trying an account that is not linked to it.

For security reasons, Auth.js does not automatically link accounts to existing accounts if the user is not signed in.

Extends

SignInError

Constructors

new AccountNotLinked(message, errorOptions)

new AccountNotLinked(message?, errorOptions?): AccountNotLinked

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

AccountNotLinked

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

kind

static kind: string = "signIn";

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "AccountNotLinked";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

AdapterError

One of the database Adapter methods failed during execution.

💡

If debug: true is set, you can check out [auth][debug] in the logs to learn more about the failed adapter method execution.

Example

[auth][debug]: adapter_getUserByEmail
{ "args": [undefined] }

Extends

AuthError

Constructors

new AdapterError(message, errorOptions)

new AdapterError(message?, errorOptions?): AdapterError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

AdapterError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "AdapterError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

AuthError

Base error class for all Auth.js errors. It’s optimized to be printed in the server logs in a nicely formatted way via the logger.error option.

Extends

Error

Constructors

new AuthError(message, errorOptions)

new AuthError(message?, errorOptions?): AuthError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

AuthError

Overrides

Error.constructor

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Overrides

Error.cause

message

message: string;

Inherited from

Error.message

name

name: string;

Inherited from

Error.name

stack?

optional stack: string;

Inherited from

Error.stack

type

type: ErrorType;

The error type. Used to identify the error in the logs.

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number;

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

Error.captureStackTrace

CallbackRouteError

This error occurs when the user cannot finish login. Depending on the provider type, this could have happened for multiple reasons.

💡

Check out [auth][details] in the logs to know which provider failed.

Example

[auth][details]: { "provider": "github" }

For an OAuth provider, possible causes are:

The user denied access to the application
There was an error parsing the OAuth Profile: Check out the provider’s profile or userinfo.request method to make sure it correctly fetches the user’s profile.
The signIn or jwt callback methods threw an uncaught error: Check the callback method implementations.

For an Email provider, possible causes are:

The provided email/token combination was invalid/missing: Check if the provider’s sendVerificationRequest method correctly sends the email.
The provided email/token combination has expired: Ask the user to log in again.
There was an error with the database: Check the database logs.

For a Credentials provider, possible causes are:

The authorize method threw an uncaught error: Check the provider’s authorize method.
The signIn or jwt callback methods threw an uncaught error: Check the callback method implementations.

💡

Check out [auth][cause] in the error message for more details. It will show the original stack trace.

Extends

AuthError

Constructors

new CallbackRouteError(message, errorOptions)

new CallbackRouteError(message?, errorOptions?): CallbackRouteError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

CallbackRouteError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "CallbackRouteError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

CredentialsSignin

Can be thrown from the authorize callback of the Credentials provider. When an error occurs during the authorize callback, two things can happen:

The user is redirected to the signin page, with error=CredentialsSignin&code=credentials in the URL. code is configurable.
If you throw this error in a framework that handles form actions server-side, this error is thrown, instead of redirecting the user, so you’ll need to handle.

Extends

Error

Constructors

new CredentialsSignin(message)

new CredentialsSignin(message?): CredentialsSignin

Parameters

Parameter	Type
`message`?	`string`

Returns

CredentialsSignin

Inherited from

Error.constructor

new CredentialsSignin(message, options)

new CredentialsSignin(message?, options?): CredentialsSignin

Parameters

Parameter	Type
`message`?	`string`
`options`?	`ErrorOptions`

Returns

CredentialsSignin

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown;

Inherited from

Error.cause

code

code: string = "credentials";

The error code that is set in the code query parameter of the redirect URL.

⚠ NOTE: This property is going to be included in the URL, so make sure it does not hint at sensitive errors.

The full error is always logged on the server, if you need to debug.

Generally, we don’t recommend hinting specifically if the user had either a wrong username or password specifically, try rather something like “Invalid credentials”.

message

message: string;

Inherited from

Error.message

name

name: string;

Inherited from

Error.name

stack?

optional stack: string;

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number;

Inherited from

Error.stackTraceLimit

type

static type: string = "CredentialsSignin";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

Error.captureStackTrace

DuplicateConditionalUI

Thrown when multiple providers have enableConditionalUI set to true. Only one provider can have this option enabled at a time.

Extends

AuthError

Constructors

new DuplicateConditionalUI(message, errorOptions)

new DuplicateConditionalUI(message?, errorOptions?): DuplicateConditionalUI

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

DuplicateConditionalUI

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "DuplicateConditionalUI";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

EmailSignInError

Happens when the login by an Email provider could not be started.

Possible causes are:

The email sent from the client is invalid, could not be normalized by EmailConfig.normalizeIdentifier
The provided email/token combination has expired: Ask the user to log in again.
There was an error with the database: Check the database logs.

Extends

SignInError

Constructors

new EmailSignInError(message, errorOptions)

new EmailSignInError(message?, errorOptions?): EmailSignInError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

EmailSignInError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

kind

static kind: string = "signIn";

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "EmailSignInError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

ErrorPageLoop

Thrown when Auth.js is misconfigured and accidentally tried to require authentication on a custom error page. To prevent an infinite loop, Auth.js will instead render its default error page.

To fix this, make sure that the error page does not require authentication.

Learn more at Guide: Error pages

Extends

AuthError

Constructors

new ErrorPageLoop(message, errorOptions)

new ErrorPageLoop(message?, errorOptions?): ErrorPageLoop

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

ErrorPageLoop

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "ErrorPageLoop";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

EventError

One of the events methods failed during execution.

Make sure that the events methods are implemented correctly and uncaught errors are handled.

Learn more at events

Extends

AuthError

Constructors

new EventError(message, errorOptions)

new EventError(message?, errorOptions?): EventError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

EventError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "EventError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

ExperimentalFeatureNotEnabled

ExperimentalFeatureNotEnabled

Thrown when an experimental feature is used but not enabled.

Extends

AuthError

Constructors

new ExperimentalFeatureNotEnabled(message, errorOptions)

new ExperimentalFeatureNotEnabled(message?, errorOptions?): ExperimentalFeatureNotEnabled

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "ExperimentalFeatureNotEnabled";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

InvalidCallbackUrl

Thrown when Auth.js is unable to verify a callbackUrl value. The browser either disabled cookies or the callbackUrl is not a valid URL.

Somebody might have tried to manipulate the callback URL that Auth.js uses to redirect the user back to the configured callbackUrl/page. This could be a malicious hacker trying to redirect the user to a phishing site. To prevent this, Auth.js checks if the callback URL is valid and throws this error if it is not.

There is no action required, but it might be an indicator that somebody is trying to attack your application.

Extends

AuthError

Constructors

new InvalidCallbackUrl(message, errorOptions)

new InvalidCallbackUrl(message?, errorOptions?): InvalidCallbackUrl

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

InvalidCallbackUrl

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "InvalidCallbackUrl";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

InvalidCheck

Thrown when a PKCE, state or nonce OAuth check could not be performed. This could happen if the OAuth provider is configured incorrectly or if the browser is blocking cookies.

Learn more at checks

Extends

AuthError

Constructors

new InvalidCheck(message, errorOptions)

new InvalidCheck(message?, errorOptions?): InvalidCheck

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

InvalidCheck

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "InvalidCheck";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

InvalidEndpoints

One of the configured OAuth or OIDC providers is missing the authorization, token or userinfo, or issuer configuration. To perform OAuth or OIDC sign in, at least one of these endpoints is required.

Learn more at OAuth2Config or Guide: OAuth Provider

Extends

AuthError

Constructors

new InvalidEndpoints(message, errorOptions)

new InvalidEndpoints(message?, errorOptions?): InvalidEndpoints

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

InvalidEndpoints

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "InvalidEndpoints";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

InvalidProvider

Thrown when an endpoint was incorrectly called without a provider, or with an unsupported provider.

Extends

AuthError

Constructors

new InvalidProvider(message, errorOptions)

new InvalidProvider(message?, errorOptions?): InvalidProvider

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

InvalidProvider

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "InvalidProvider";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

JWTSessionError

Logged on the server when Auth.js could not decode or encode a JWT-based (strategy: "jwt") session.

Possible causes are either a misconfigured secret or a malformed JWT or encode/decode methods.

When this error is logged, the session cookie is destroyed.

Learn more at secret, jwt.encode or jwt.decode for more information.

Extends

AuthError

Constructors

new JWTSessionError(message, errorOptions)

new JWTSessionError(message?, errorOptions?): JWTSessionError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

JWTSessionError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "JWTSessionError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

MissingAdapter

Thrown if Auth.js is misconfigured. This could happen if you configured an Email provider but did not set up a database adapter, or tried using a strategy: "database" session without a database adapter. In both cases, make sure you either remove the configuration or add the missing adapter.

Learn more at Database Adapters, Email provider or Concept: Database session strategy

Extends

AuthError

Constructors

new MissingAdapter(message, errorOptions)

new MissingAdapter(message?, errorOptions?): MissingAdapter

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

MissingAdapter

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "MissingAdapter";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

MissingAdapterMethods

Thrown similarily to MissingAdapter, but only some required methods were missing.

Make sure you either remove the configuration or add the missing methods to the adapter.

Learn more at Database Adapters

Extends

AuthError

Constructors

new MissingAdapterMethods(message, errorOptions)

new MissingAdapterMethods(message?, errorOptions?): MissingAdapterMethods

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

MissingAdapterMethods

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "MissingAdapterMethods";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

MissingAuthorize

Thrown when a Credentials provider is missing the authorize configuration. To perform credentials sign in, the authorize method is required.

Learn more at Credentials provider

Extends

AuthError

Constructors

new MissingAuthorize(message, errorOptions)

new MissingAuthorize(message?, errorOptions?): MissingAuthorize

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

MissingAuthorize

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "MissingAuthorize";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

MissingCSRF

Error for missing CSRF tokens in client-side actions (signIn, signOut, useSession#update). Thrown when actions lack the double submit cookie, essential for CSRF protection.

CSRF (Cross-Site Request Forgery) is an attack leveraging authenticated user credentials for unauthorized actions.

Double submit cookie pattern, a CSRF defense, requires matching values in a cookie and request parameter. More on this at MDN Web Docs.

Extends

SignInError

Constructors

new MissingCSRF(message, errorOptions)

new MissingCSRF(message?, errorOptions?): MissingCSRF

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

MissingCSRF

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

kind

static kind: string = "signIn";

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "MissingCSRF";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

MissingSecret

Auth.js requires a secret or multiple secrets to be set, but none was not found. This is used to encrypt cookies, JWTs and other sensitive data.

If you are using a framework like Next.js, we try to automatically infer the secret from the AUTH_SECRET, AUTH_SECRET_1, etc. environment variables. Alternatively, you can also explicitly set the AuthConfig.secret option.

💡

To generate a random string, you can use the Auth.js CLI: npx auth secret

Extends

AuthError

Constructors

new MissingSecret(message, errorOptions)

new MissingSecret(message?, errorOptions?): MissingSecret

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

MissingSecret

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "MissingSecret";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

MissingWebAuthnAutocomplete

MissingWebAuthnAutocomplete

Thrown when a WebAuthn provider has enableConditionalUI set to true but no formField has webauthn in its autocomplete param.

The webauthn autocomplete param is required for conditional UI to work.

Extends

AuthError

Constructors

new MissingWebAuthnAutocomplete(message, errorOptions)

new MissingWebAuthnAutocomplete(message?, errorOptions?): MissingWebAuthnAutocomplete

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "MissingWebAuthnAutocomplete";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

OAuthAccountNotLinked

Thrown when an Email address is already associated with an account but the user is trying an OAuth account that is not linked to it.

For security reasons, Auth.js does not automatically link OAuth accounts to existing accounts if the user is not signed in.

💡

If you trust the OAuth provider to have verified the user’s email address, you can enable automatic account linking by setting allowDangerousEmailAccountLinking: true in the provider configuration.

Extends

SignInError

Constructors

new OAuthAccountNotLinked(message, errorOptions)

new OAuthAccountNotLinked(message?, errorOptions?): OAuthAccountNotLinked

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

OAuthAccountNotLinked

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

kind

static kind: string = "signIn";

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "OAuthAccountNotLinked";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

OAuthCallbackError

Thrown when an OAuth provider returns an error during the sign in process. This could happen for example if the user denied access to the application or there was a configuration error.

For a full list of possible reasons, check out the specification Authorization Code Grant: Error Response

Extends

SignInError

Constructors

new OAuthCallbackError(message, errorOptions)

new OAuthCallbackError(message?, errorOptions?): OAuthCallbackError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

OAuthCallbackError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

kind

static kind: string = "signIn";

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "OAuthCallbackError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

OAuthProfileParseError

This error occurs during an OAuth sign in attempt when the provider’s response could not be parsed. This could for example happen if the provider’s API changed, or the OAuth2Config.profile method is not implemented correctly.

Extends

AuthError

Constructors

new OAuthProfileParseError(message, errorOptions)

new OAuthProfileParseError(message?, errorOptions?): OAuthProfileParseError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

OAuthProfileParseError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "OAuthProfileParseError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

OAuthSignInError

Happens when login by OAuth could not be started.

Possible causes are:

The Authorization Server is not compliant with the OAuth 2.0 or the OIDC specification. Check the details in the error message.

💡

Check out [auth][details] in the logs to know which provider failed.

Example

[auth][details]: { "provider": "github" }

Extends

SignInError

Constructors

new OAuthSignInError(message, errorOptions)

new OAuthSignInError(message?, errorOptions?): OAuthSignInError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

OAuthSignInError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

kind

static kind: string = "signIn";

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "OAuthSignInError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

SessionTokenError

Logged on the server when Auth.js could not retrieve a session from the database (strategy: "database").

The database adapter might be misconfigured or the database is not reachable.

Learn more at Concept: Database session strategy

Extends

AuthError

Constructors

new SessionTokenError(message, errorOptions)

new SessionTokenError(message?, errorOptions?): SessionTokenError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

SessionTokenError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "SessionTokenError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

SignInError

Base error class for all Auth.js errors. It’s optimized to be printed in the server logs in a nicely formatted way via the logger.error option.

Extends

AuthError

Constructors

new SignInError(message, errorOptions)

new SignInError(message?, errorOptions?): SignInError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

SignInError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

kind

static kind: string = "signIn";

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

SignOutError

Represents an error that occurs during the sign-out process. This error is logged when there are issues in terminating a user’s session, either by failing to delete the session from the database (in database session strategies) or encountering issues during other parts of the sign-out process, such as emitting sign-out events or clearing session cookies.

The session cookie(s) are emptied even if this error is logged.

Extends

AuthError

Constructors

new SignOutError(message, errorOptions)

new SignOutError(message?, errorOptions?): SignOutError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

SignOutError

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "SignOutError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

UnknownAction

Auth.js was requested to handle an operation that it does not support.

See AuthAction for the supported actions.

Extends

AuthError

Constructors

new UnknownAction(message, errorOptions)

new UnknownAction(message?, errorOptions?): UnknownAction

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

UnknownAction

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "UnknownAction";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

UnsupportedStrategy

Thrown when a Credentials provider is present but the JWT strategy (strategy: "jwt") is not enabled.

Learn more at strategy or Credentials provider

Extends

AuthError

Constructors

new UnsupportedStrategy(message, errorOptions)

new UnsupportedStrategy(message?, errorOptions?): UnsupportedStrategy

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

UnsupportedStrategy

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "UnsupportedStrategy";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

UntrustedHost

Thrown when the trustHost option was not set to true.

Auth.js requires the trustHost option to be set to true since it’s relying on the request headers’ host value.

Official Auth.js libraries might attempt to automatically set the trustHost option to true if the request is coming from a trusted host on a trusted platform.

Learn more at trustHost or Guide: Deployment

Extends

AuthError

Constructors

new UntrustedHost(message, errorOptions)

new UntrustedHost(message?, errorOptions?): UntrustedHost

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

UntrustedHost

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "UntrustedHost";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

Verification

The user’s email/token combination was invalid. This could be because the email/token combination was not found in the database, or because the token has expired. Ask the user to log in again.

Extends

AuthError

Constructors

new Verification(message, errorOptions)

new Verification(message?, errorOptions?): Verification

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

Verification

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "Verification";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from

WebAuthnVerificationError

WebAuthnVerificationError

Thrown when a WebAuthn provider fails to verify a client response.

Extends

AuthError

Constructors

new WebAuthnVerificationError(message, errorOptions)

new WebAuthnVerificationError(message?, errorOptions?): WebAuthnVerificationError

Parameters

Parameter	Type
`message`?	`string` \| `ErrorOptions`
`errorOptions`?	`ErrorOptions`

Returns

Inherited from

Properties

cause?

optional cause: Record<string, unknown> & {
  err: Error;
};

Type declaration

err?

optional err: Error;

Inherited from

message

message: string;

Inherited from

name

name: string;

Inherited from

stack?

optional stack: string;

Inherited from

type

type: ErrorType;

The error type. Used to identify the error in the logs.

Inherited from

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Optional override for formatting stack traces

See

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Inherited from

type

static type: string = "WebAuthnVerificationError";

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Parameter	Type
`targetObject`	`object`
`constructorOpt`?	`Function`

Returns

void

Inherited from