Class ErrorResponse

Error class thrown in case of an authentication error.

See

https://openid.net/specs/openid-connect-core-1_0.html#AuthError

Hierarchy

  • Error
    • ErrorResponse

Constructors

constructor

Properties

error error_description error_uri form? message name session_state stack? state? url_state? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new ErrorResponse(args, form?): ErrorResponse

  • Parameters

    • args: {
          error?: null | string;
          error_description?: null | string;
          error_uri?: null | string;
          session_state?: null | string;
          url_state?: string;
          userState?: unknown;
      }
      • Optional error?: null | string
      • Optional error_description?: null | string
      • Optional error_uri?: null | string
      • Optional session_state?: null | string
      • Optional url_state?: string
      • Optional userState?: unknown
    • Optional form: URLSearchParams

      The x-www-form-urlencoded request body sent to the authority server

    Returns ErrorResponse

Properties

Readonly error

error: null | string

An error code string that can be used to classify the types of errors that occur and to respond to errors.

Readonly error_description

error_description: null | string

additional information that can help a developer identify the cause of the error.

Readonly error_uri

error_uri: null | string

URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

Optional Readonly form

form?: URLSearchParams

The x-www-form-urlencoded request body sent to the authority server

message

message: string

Readonly name

name: string = "ErrorResponse"

Marker to detect class: "ErrorResponse"

Readonly session_state

session_state: null | string

Optional stack

stack?: string

Optional state

state?: unknown

custom state data set during the initial signin request

Optional url_state

url_state?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc