Type Alias WsMessage

WsMessage:
| { data: string; type: "text"; json<T = unknown>(): T }
| { data: Uint8Array; type: "binary" }

A single inbound WebSocket message.

Text frames arrive as { type: 'text' } with a string payload; binary frames arrive as { type: 'binary' } with a Uint8Array payload. Branch on type before reading data.

Type Declaration

{ data: string; type: "text"; json<T = unknown>(): T }
- data: string
- type: "text"
- json: function
  - json<T = unknown>(): T
    Parses the text payload as JSON.
    Type Parameters
    
    T = unknown
    The expected shape of the decoded value.
    Returns T
    The parsed value.
    
    Throws
    If the text is not valid JSON.
    
    Since
    1.0.2
    Defined in src/ws/index.ts:43
{ data: Uint8Array; type: "binary" }

Since

1.0.0

Type Alias WsMessage

Type Declaration

data: string

type: "text"

json: function

Type Parameters

Returns T

Throws

Since

Since

Settings