WebSocketFrame

WebSocketFrame = object

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

A decoded frame header, and the payload of a control frame.

Properties

fin

readonly fin: boolean

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

Whether this is the last fragment of its message.

---

maskKey

readonly maskKey: Uint8Array | null

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

The masking key, present exactly when the sender is a client.

---

opcode

readonly opcode: WebSocketOpcode

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

---

payload

readonly payload: Uint8Array | null

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

A control frame’s payload, already unmasked. null for a data frame, whose payload follows as the decoded value’s body — streamed, and still masked when maskKey is set.

---

payloadLength

readonly payloadLength: number

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

The payload length the header declares.

---

rsv

readonly rsv: number

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

The RSV1, RSV2 and RSV3 bits as a 3-bit number, RSV1 the highest. Zero unless an extension negotiated them (permessage-deflate uses RSV1).