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: ResponseBodySchema()Copiar enlace

ResponseBodySchema<T>(data): TUnion<[TObject<{ data: T; ok: TLiteral<true>; }>, TObject<{ error: TObject<{ category: TUnion<[TLiteral<"transient">, TLiteral<"permanent">, TLiteral<"recoverable">]>; causedBy: TOptional<TArray<TUnion<[TObject<...>, TArray<...>]>>>; code: TString; details: TOptional<TUnion<[TObject<{ }>, TArray<TUnknown>]>>; message: TString; retryable: TBoolean; suggestedAction: TOptional<TString>; }>; ok: TLiteral<false>; }>]>

Schema de IResponseBody para un TData concreto: lo que viaja en el payload de un reply NATS. Los clientes NATS lo validan con compileContract(...) antes de leer data (frontera de confianza: otro proceso). error.code se valida como string (el código concreto lo tipa el servicio que responde).

Type ParametersCopiar enlace

TCopiar enlace

T extends TSchema

ParametersCopiar enlace

dataCopiar enlace

T

Schema de la data de éxito (p. ej. ProbeReplySchema).

ReturnsCopiar enlace

TUnion<[TObject<{ data: T; ok: TLiteral<true>; }>, TObject<{ error: TObject<{ category: TUnion<[TLiteral<"transient">, TLiteral<"permanent">, TLiteral<"recoverable">]>; causedBy: TOptional<TArray<TUnion<[TObject<...>, TArray<...>]>>>; code: TString; details: TOptional<TUnion<[TObject<{ }>, TArray<TUnknown>]>>; message: TString; retryable: TBoolean; suggestedAction: TOptional<TString>; }>; ok: TLiteral<false>; }>]>

Unión discriminada por ok.