SDK y paquetes@styx/api-contractsindexfunctions

Function: domainProblemFields()

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.

Function: domainProblemFields()

domainProblemFields<T, C>(table, code, detail): object

Campos de extensión RFC 9457 de un error de dominio, listos para problem(status, domainProblemFields(TABLE, code, detail)) en una ruta. code llega literal (el switch de la ruta lo estrecha), title es el resumen estable de la tabla y detail el mensaje concreto.

Type Parameters

T

T extends Readonly<Record<string, IProblemMetadataRow>>

C

C extends string

Parameters

table

T

Tabla de metadata del dominio.

code

C

Código literal.

detail

string

Mensaje de la ocurrencia (sin secretos: lo ve el cliente).

Returns

object

Miembros del problem (sin status, que pone problem()).

category

readonly category: ErrorCategory

code

readonly code: C

detail

readonly detail: string

retryable

readonly retryable: boolean

title

readonly title: string

type

readonly type: string