ws-asyncapi API / core / Connection

Interface: Connection

Defined in: .api-entries/core/index.d.ts:465

Mutable per-connection state shared across a socket's lifetime.

Properties

ws

readonly ws: WebSocketImplementation<any, any>

Defined in: .api-entries/core/index.d.ts:467

the adapter's WebSocket implementation for this socket

---

request

readonly request: RequestData<any, any, any>

Defined in: .api-entries/core/index.d.ts:469

connection request data (query / headers / params)

---

data

data: any

Defined in: .api-entries/core/index.d.ts:471

derived context bag (filled by openConnection)

---

sessionId?

optional sessionId?: string

Defined in: .api-entries/core/index.d.ts:473

recovery session id, assigned on the Hello handshake

---

outbound?

optional outbound?: OutboundRpc

Defined in: .api-entries/core/index.d.ts:475

pending server→client (outbound) RPCs for this connection

---

streams?

optional streams?: StreamRegistry

Defined in: .api-entries/core/index.d.ts:477

active streams for this connection (for cancel / abort-on-close)

---

presenceRoom?

optional presenceRoom?: string

Defined in: .api-entries/core/index.d.ts:479

this connection's presence room (set on open when .presence is enabled)

---

isPresent?

optional isPresent?: boolean

Defined in: .api-entries/core/index.d.ts:482

whether this connection currently has presence state announced (so close knows to emit a leave)