SDK y paquetes@styx/busindexinterfaces

Interface: IBusNats

Referencia de @styx/bus generada de su TSDoc.

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

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

Interface: IBusNats

Quien pide por el bus (el adapter de un servicio depende de esto, no de NATS).

Extends

Methods

close()

close(): Promise<void>

Drena y cierra la conexión NATS.

Returns

Promise<void>


emit()

emit<C>(contract, msg): BusResult<void>

evt por NATS core (observaciones latest-wins; sin persistencia ni ack).

Type Parameters

C

C extends IContract<"evt", TSchema, TSchema | undefined>

Parameters

contract

C

msg

RequestOf<C>

Returns

BusResult<void>

Inherited from

IBusEmitter.emit


emitAcked()

emitAcked<C>(contract, msg): Promise<BusResult<number>>

evt a un stream JetStream con confirmación (el servicio es dueño del stream); devuelve el seq. Un payload fuera de contrato no sale: BUS_INVALID_REQUEST.

Type Parameters

C

C extends IContract<"evt", TSchema, TSchema | undefined>

Parameters

contract

C

msg

RequestOf<C>

Returns

Promise<BusResult<number>>

Inherited from

IBusEmitter.emitAcked


isConnected()

isConnected(): boolean

Conexión establecida (falso durante una reconexión o tras cerrar): readiness.

Returns

boolean


request()

request<C>(contract, msg, opts?): Promise<BusResult<ReplyOf<C>>>

cmd/qry con respuesta verificada; los fallos del bus son BUS_*.

Type Parameters

C

C extends IContract<"cmd" | "qry", TSchema, TSchema | undefined>

Parameters

contract

C

msg

RequestOf<C>

opts?

IBusRequestOptions

Returns

Promise<BusResult<ReplyOf<C>>>

Inherited from

IBusRequester.request


serve()

serve(handlers): void

Registra y sirve los handlers del servicio (una vez; después el router queda congelado). Aparte de connect porque un handler puede depender de adapters que usan este mismo bus.

Parameters

handlers

readonly IHandler<IContract<ContractKind, TSchema, TSchema | undefined>>[]

Returns

void