WebSocketOutboundFrame

WebSocketOutboundFrame = object

Defined in: packages/format-websocket/src/frame/websocket-frame.ts:44

A frame to encode.

Properties

fin?

readonly optional fin?: boolean

Defined in: packages/format-websocket/src/frame/websocket-frame.ts:46

Defaults to true: an unfragmented message, or a control frame.

---

opcode

readonly opcode: WebSocketOpcode

Defined in: packages/format-websocket/src/frame/websocket-frame.ts:51

---

payload

readonly payload: Uint8Array

Defined in: packages/format-websocket/src/frame/websocket-frame.ts:54

The unmasked payload; the encoder masks it when the role requires.

---

rsv?

readonly optional rsv?: number

Defined in: packages/format-websocket/src/frame/websocket-frame.ts:49

RSV bits as in WebSocketFrame.rsv. Defaults to 0.