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

    Class ValidationError

    Thrown when a runtime validator (Zod, in this SDK) rejects an upstream response. The context field surfaces which boundary the payload came from (e.g. 'BFF /context', 'ClientLogin3', 'OIDC token endpoint') so consumer dashboards can group drift alerts without parsing the message string.

    The underlying ZodError (or any other validator error) is attached through the standard cause chain.

    Hierarchy (View Summary)

    Index
    • Builds the error from the validator's message, the boundary context label, and (typically) the underlying ZodError as the cause.

      Parameters

      • message: string

        Human-readable error description.

      • options: { cause?: unknown; context: string }

        Boundary label plus optional cause.

        • Optionalcause?: unknown

          Original error (typically a ZodError).

        • context: string

          Boundary the rejected payload came from.

      Returns ValidationError

    cause?: unknown
    context: string
    message: string
    name: "ValidationError" = 'ValidationError'
    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