SDK y paquetes@styx/api-contractsindexinterfaces

Interface: IProjectedTransportSignals

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: IProjectedTransportSignals

Subset público del snapshot de transporte emitido por WS.

Diferencias con ITransportSignalsSnapshot:

  • Solo exponemos métricas que el cliente final consume para UI/UX (latency, bandwidth, congestion rate).
  • NO exponemos version (interno al channel Zig), congestion_events (contador raw de observability), ni ts_ms (re-derivado en el WS emit con timestamp del momento del receive).
  • Añadimos receivedAt (timestamp del WS emit, no del daemon) para que el cliente pueda calcular jitter de propagación.

Properties

availableBps

readonly availableBps: number

Bandwidth disponible en bps (estimación daemon).


availableMbps

readonly availableMbps: number

Bandwidth disponible en Mbps redondeado para UI (derivado de availableBps).


latencyMs

readonly latencyMs: number

Latencia de transporte observada en milisegundos (derivado de rtt_ns / 1e6).


lossRate

readonly lossRate: number

Tasa de pérdida [0,1] del último snapshot.


receivedAt

readonly receivedAt: number

Timestamp del WS emit (epoch ms). NO confundir con ts_ms del snapshot.