@ts-rust/std - v0.0.5
    Preparing search index...

    Class AnyError<T>

    A generic error class extending Error with a typed kind and optional reason.

    This class provides a structured way to represent errors with a category (kind) of a primitive type (e.g., string, number, enum) and an optional underlying cause (reason). The error message is automatically formatted to include both the kind and reason (if provided), making it suitable for categorized error handling in libraries or applications.

    Type Parameters

    • T extends Primitive

      The type of the error kind, constrained to Primitive (e.g., string, number, enum).

      const err1 = new AnyError("Invalid input", "ValidationError");
      const err2 = new AnyError("File not found", 404, new Error("ENOENT"));

      expect(err1.message).toBe("[ValidationError] Invalid input.");
      expect(err2.message).toBe("[404] File not found. Reason: ENOENT");
      expect(err2.kind).toBe(404);
      expect(err2.reason.message).toBe("ENOENT");

    Hierarchy (View Summary)

    Index

    Constructors

    • Constructs a new AnyError instance with a message, kind, and optional reason.

      The error’s message is formatted as [kind] message or [kind] message. Reason: reason if a reason is provided. The name is set to the constructor’s name, and the reason is normalized to an Error instance.

      Type Parameters

      Parameters

      • message: string

        The descriptive message for the error.

      • kind: T

        The category or type of the error, a primitive value.

      • Optionalreason: unknown

        An optional underlying cause, which can be any value (converted to Error if not already).

      Returns AnyError<T>

    Properties

    cause?: unknown
    kind: T

    The category or type of the error, represented as a primitive value.

    This readonly property identifies the error’s kind, such as a string code or numeric status, and is set during construction.

    message: string
    name: string
    reason: Error

    The underlying cause of the error, represented as an Error instance.

    This readonly property holds the reason provided during construction, normalized to an Error object. If no reason is given, it defaults to an error wrapping the kind.

    stack?: string
    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Optional override for formatting stack traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void