Documentation / @super-line/core / Handshake

Interface: Handshake

Defined in: packages/core/src/transport.ts:31

The normalized handshake handed to authenticate, replacing the raw IncomingMessage. Each transport fills what it has: ws/sse populate headers/query; libp2p/webrtc populate peer. raw is the transport-specific escape hatch.

Properties

headers

headers: Record<string, string | string[] | undefined>

Defined in: packages/core/src/transport.ts:35

Request headers (ws/sse fill these; peer transports leave them sparse).

---

peer?

optional peer?: object

Defined in: packages/core/src/transport.ts:39

Peer identity, for transports that authenticate one (libp2p/webrtc).

addr?

optional addr?: string

id

id: string

---

query

query: Record<string, string>

Defined in: packages/core/src/transport.ts:37

Role + params, decoded uniformly (WS reads them from the URL query string).

---

raw

raw: unknown

Defined in: packages/core/src/transport.ts:41

Escape hatch: the IncomingMessage for WS, the signaling payload for libp2p, etc.

---

transport

transport: string

Defined in: packages/core/src/transport.ts:33

Transport id, e.g. 'websocket' | 'loopback' | 'sse' | 'libp2p'.