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

    Class AuthenticationThrottledError

    MELCloud is temporarily refusing sign-ins (login throttle): Classic reports it as ErrorId 6 on ClientLogin3, Home as HTTP 429 from the token endpoints. Retrying a login keeps the lockout alive, so the automatic re-login backoff widens when this error arms it; sessions established BEFORE the throttle keep working (MELCloud stays generous with existing keys).

    retryAfter carries the window the server itself announced — Classic counts it down in LoginMinutes — mirroring RateLimitError's field so a consumer can say "try again in N minutes" without parsing the message. It is null when the upstream announced none, which is what makes the caller fall back to its own conservative pause.

    Hierarchy (View Summary)

    Index
    cause?: unknown
    message: string
    name: "AuthenticationThrottledError" = 'AuthenticationThrottledError'
    retryAfter: Temporal.Duration | null
    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