Class CliError

Represents an error specific to the Stone CLI.

Extends RuntimeError to provide a custom error type for handling CLI-related issues.

Hierarchy (View Summary)

RuntimeError
- CliError
  - CancellationError

Index

Constructors

Properties

cause? code? metadata?

Methods

toString create

Constructors

constructor

new CliError(message: string, options?: ErrorOptions): CliError
Creates a new instance of CliError.
Parameters
- message: string
  The error message describing the issue.
- Optionaloptions: ErrorOptions
  Optional additional error options.
Returns CliError

Overrides RuntimeError.constructor

Properties

`Optional` `Readonly`cause

cause?: Error

`Optional` `Readonly`code

code?: string

`Optional` `Readonly`metadata

metadata?: unknown

Methods

toString

toString(multiline?: boolean): string
Converts the error to a formatted string representation.
Parameters
- Optionalmultiline: boolean
  Determine if output value must be multiline or not.
Returns string
A formatted error string.

Inherited from RuntimeError.toString

`Static`create

create<T extends RuntimeError = RuntimeError>(
message: string,
options?: ErrorOptions,
): T
Create a RuntimeError.
Type Parameters
- T extends RuntimeError = RuntimeError
Parameters
- message: string
- Optionaloptions: ErrorOptions
  The options to create a RuntimeError.
Returns T
A new RuntimeError instance.

Inherited from RuntimeError.create