SDK y paquetes@styx/api-contractsindexinterfaces

Interface: IContractError<TCode>

Referencia de @styx/api-contracts generada de su TSDoc.

ImplementadoSin versión del tren todavía· generada desde packages/api-contracts/package.json

Página generada desde el TSDoc de @styx/api-contracts. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Interface: IContractError<TCode>

Error contractual tipado.

Type Parameters

TCode

TCode extends string = string

Union de códigos de error específicos del dominio (ej. 'CATALOG_NOT_FOUND' | 'CATALOG_INVALID_INPUT').

Properties

category

readonly category: ErrorCategory

Categoría del error para decisión de reintento.


causedBy?

readonly optional causedBy?: readonly IErrorCause[]

Causas raíz encadenadas (para errores compuestos). Opcional.


code

readonly code: TCode

Código de error específico del dominio (ej. CATALOG_NOT_FOUND).


details?

readonly optional details?: Readonly<Record<string, unknown>>

Detalles adicionales (payload parcial, contexto, etc.). Opcional.


message

readonly message: string

Mensaje legible para logs (NO para mostrar al usuario sin sanitizar).


retryable

readonly retryable: boolean

¿Es seguro reintentar esta operación?


suggestedAction?

readonly optional suggestedAction?: string

Acción sugerida para el caller (opcional, para debugging).