Design System Utilities @ 0.1.1-alpha.0
    Preparing search index...

    Class Tokens_Error<T_CauseType, T_IsZodError>Internal

    Used to throw errors while compiling the tokens.

    0.1.0-alpha

    Type Parameters

    • T_CauseType extends unknown | undefined = never
    • T_IsZodError extends T_CauseType extends z.ZodError ? true : false = T_CauseType extends z.ZodError ? true : false

    Hierarchy

    • AbstractError<never, Context>
      • Tokens_Error
    Index

    Constructors

    Properties

    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.

    args: never

    Additional arguments for this instance, if any.

    context: Context
    message: string
    name: string

    Represents the name for the type of error.

    opts: { cause: T_CauseType; isZodError: T_IsZodError }
    cause?: unknown

    Represents the cause of the error (e.g., a different exception that was caught).

    stack?: string
    ARGS_DEFAULT?: undefined

    Default args object, if applicable.

    Methods

    • Internal

      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

    • Internal

      The object shape used when converting to JSON.

      Returns {
          cause: unknown;
          context: Context;
          issues: ZodIssue[];
          message: string;
          name: string;
          stack: string | undefined;
          string: string;
      }

    • Internal

      Overrides the default function to return a string representation of this object.

      Returns string

    • Internal

      Overrides the default function to return an object representation of this object.

      Returns JSON<Context>