Class CmpStrError

Base error class for CmpStr.

It provides a standard code field and a consistent toString() / toJSON() output without changing the original error message expectations.

Hierarchy (View Summary)

Error
- CmpStrError

Index

Constructors

Properties

code meta? when

Methods

format toJSON toString

Constructors

constructor

new CmpStrError(
    code: string,
    message: string,
    meta?: CmpStrErrorMeta,
    cause?: unknown,
): CmpStrError
Constructor for CmpStrError.

Will construct an error with a code, message, optional metadata, and optional cause.
Parameters
- code: string
  A short, machine-readable error code
- message: string
  The error message (human-readable)
- Optionalmeta: CmpStrErrorMeta
  Optional structured metadata for the error
- Optionalcause: unknown
  Optional cause (native JS Error chaining)
Returns CmpStrError
Overrides Error.constructor
- Defined in utils/Errors.ts:66

Properties

`Readonly`code

code: string

A short, machine-readable error code

`Optional` `Readonly`meta

meta?: CmpStrErrorMeta

Optional structured metadata for the error

`Readonly`when

when: string = ...

Timestamp when the error was created (ISO 8601)

Methods

format

format(stack?: boolean): string
Format the error into a readable string, including code, message, and optional metadata.
Parameters
- Optionalstack: boolean = false
  Whether to include the stack trace in the output
Returns string
- Defined in utils/Errors.ts:84

toJSON

toJSON(stack?: boolean): CmpStrErrorJSON
Serialize the error into a plain object for JSON output.
Parameters
- Optionalstack: boolean = false
  Whether to include the stack trace in the JSON
Returns CmpStrErrorJSON
- Defined in utils/Errors.ts:107

toString

toString(): string
Pretty string representation of the error.

Returns string
- Defined in utils/Errors.ts:98