BSB Node.js Type Definitions
    Preparing search index...

    Class ValidationError

    Custom error class for validation failures.

    Hierarchy

    • Error
      • ValidationError
    Index

    Constructors

    • Create a new validation error.

      Parameters

      • message: string

        Error message

      • zodError: ZodError<any>

        The underlying Zod validation error

      • eventName: string

        Name of the event that failed validation

      • direction: "output" | "input"

        Whether the failure was on 'input' or 'output'

      Returns ValidationError

    Properties

    zodError: ZodError<any>

    The underlying Zod validation error

    eventName: string

    Name of the event that failed validation

    direction: "output" | "input"

    Whether the failure was on 'input' or 'output'

    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

    • Get a formatted string representation of the validation errors.

      Returns string

      Formatted error details

    • 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