noggin

NogginError

The error class every engine function throws for usage or state errors. Carries a stable code, a CLI-mirrored exitCode, and a frozen structured data payload. Hosts key user-facing strings off code; message is a short host-neutral fallback.

Thrown by every engine function on usage/state errors.

Extends

Constructors

Constructor
new NogginError(message: string, opts?: {
  code?: string;
  data?: NogginErrorData;
  exitCode?: number;
}): NogginError;
Parameters
ParameterType
messagestring
opts?{ code?: string; data?: NogginErrorData; exitCode?: number; }
opts.code?string
opts.data?NogginErrorData
opts.exitCode?number
Returns

NogginError

Overrides
Error.constructor

Properties

PropertyModifierTypeDescriptionInherited from
cause?publicunknown-Error.cause
codereadonlystring--
datareadonlyReadonly<NogginErrorData>Frozen, structured payload. See NogginErrorData.-
exitCodereadonlynumberMirrors the CLI exit code (1 = runtime/state, 2 = usage/parse/invalid).-
messagepublicstring-Error.message
namepublicstring-Error.name
stack?publicstring-Error.stack