noggin

JsonEnvelope

The versioned wrapper the CLI's --json mode, MCP tools, and RPC responses use to carry either a successful verb result or a structured error. Discriminated on status.

JsonEnvelope

type JsonEnvelope<T> = 
  | SuccessEnvelope<T>
  | ErrorEnvelope;

Type Parameters

Type ParameterDefault type
Tunknown

SuccessEnvelope

Type Parameters

Type ParameterDefault type
Tunknown

Properties

PropertyType
dataT
envelopeVersionnumber
status"ok"
verbstring

ErrorEnvelope

Properties

PropertyTypeDescription
envelopeVersionnumber-
error{ code: string; data?: NogginErrorData; exitCode: number; message: string; }-
error.codestring-
error.data?NogginErrorDataStructured payload mirroring NogginError.data. Omitted when the underlying error carries no data fields.
error.exitCodenumber-
error.messagestring-
status"error"-
verbstring-