MELCloud & MELCloud Home API for Node.js - v48.2.0
    Preparing search index...

    Class HttpError<T>

    Thrown by HttpClient whenever an upstream response has a non-2xx status. The shape mirrors what downstream code needs: response.status, response.headers, and response.data.

    Type Parameters

    • T = unknown

      Type of the parsed body of the failed response, exposed as response.data.

    Hierarchy

    Index
    • Builds the error from the response triplet plus an optional snapshot of the request that produced it.

      Type Parameters

      • T = unknown

        Type of the parsed body of the failed response, exposed as response.data.

      Parameters

      • message: string

        Human-readable error description.

      • options: {
            cause?: unknown;
            config?: HttpErrorRequestConfig;
            response: {
                data: T;
                headers: Record<string, string | string[]>;
                status: number;
            };
        }

        Response triplet plus an optional request snapshot.

        • Optionalcause?: unknown

          Original error that triggered this one.

        • Optionalconfig?: HttpErrorRequestConfig

          Snapshot of the request that triggered the error.

        • response: { data: T; headers: Record<string, string | string[]>; status: number }

          Normalized response that carried the non-2xx status.

          • data: T

            Parsed (or raw text) response body.

          • headers: Record<string, string | string[]>

            HTTP headers, multi-valued set-cookie preserved as an array.

          • status: number

            HTTP status code.

      Returns HttpError<T>

    cause?: unknown
    isHttpError: true
    message: string
    name: string
    response: {
        data: T;
        headers: Record<string, string | string[]>;
        status: number;
    }
    stack?: 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.

    • 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

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error