Skip to content

CLIErrorJSON ​

Shape returned by CLIError.toJSON().

Signatures ​

ts
interface CLIErrorJSON {}

Members ​

Properties ​

code ​

Stable machine-readable identifier for programmatic matching.

ts
code: ErrorCode;

details ​

Structured payload for machine consumers, when available.

ts
details?: Readonly<Record<string, unknown>>;

exitCode ​

Process exit code associated with this error.

ts
exitCode: number;

message ​

Human-readable description of what went wrong.

ts
message: string;

name ​

Error class name (e.g. 'CLIError', 'ParseError').

ts
name: string;

suggest ​

Actionable hint shown to the user, when available.

ts
suggest?: string;

See Also ​

Released under the MIT License.