Class CredentialsSignin

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

  1. The user is redirected to the signin page, with error=CredentialsSignin&code=credentials in the URL. code is configurable.
  2. 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.

Hierarchy

  • SignInError
    • CredentialsSignin

Constructors

constructor

Properties

cause? code message name stack? type kind prepareStackTrace? stackTraceLimit type

Methods

captureStackTrace

Constructors

constructor

  • new CredentialsSignin(message?, errorOptions?): CredentialsSignin

  • Parameters

    • Optionalmessage: string | ErrorOptions
    • OptionalerrorOptions: ErrorOptions

    Returns CredentialsSignin

Properties

Optionalcause

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

code

code: string

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

name

name: string

Optionalstack

stack?: string

type

type: ErrorType

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

Statickind

kind: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Statictype

type: string

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods