@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Class ClientCredentialsExchangeError

    Raised when the authorization server rejects a client credentials exchange or the token endpoint is unreachable/malformed.

    The kind discriminator lets callers branch without string-matching on the message:

    • oauth: the AS returned a structured OAuth error (RFC 6749 §5.2 — invalid_client, invalid_grant, invalid_scope, …). Read oauthError / oauthErrorDescription.
    • malformed: the AS returned HTTP 200 but no access_token, or a non-JSON body.
    • network: the exchange never reached the AS (DNS failure, connection refused, timeout, TLS error).

    Hierarchy

    • Error
      • ClientCredentialsExchangeError
    Index

    Constructors

    Properties

    code: "client_credentials_exchange_failed" = 'client_credentials_exchange_failed'
    kind: "oauth" | "malformed" | "network"
    oauthError?: string
    oauthErrorDescription?: string
    httpStatus?: number
    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.

    cause?: unknown
    name: string
    message: string
    stack?: string

    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