oidc-client-ts
    Preparing search index...

    Class ErrorResponse

    Error class thrown in case of an authentication error.

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

    Hierarchy

    • Error
      • ErrorResponse
    Index

    Constructors

    constructor

    Properties

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

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Parameters

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

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

      Returns ErrorResponse

    Properties

    error: null | string

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

    error_description: null | string

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

    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.

    form?: URLSearchParams

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

    message: string
    name: string = "ErrorResponse"

    Marker to detect class: "ErrorResponse"

    session_state: null | string
    stack?: string
    state?: unknown

    custom state data set during the initial signin request

    url_state?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods