Skip to main content
Version: 11.x

Interface: Encoder

Defined in: packages/server/dist/adapters/ws.d.mts:22

Encoder for WebSocket wire format. Encodes outgoing messages and decodes incoming messages.

Example

ts
const customEncoder: Encoder = {
encode: (data) => myFormat.stringify(data),
decode: (data) => myFormat.parse(data),
};
ts
const customEncoder: Encoder = {
encode: (data) => myFormat.stringify(data),
decode: (data) => myFormat.parse(data),
};

Methods

decode()

decode(data): unknown

Defined in: packages/server/dist/adapters/ws.d.mts:26

Decode data received from the wire

Parameters

ParameterType
datastring | ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns

unknown


encode()

encode(data): string | Uint8Array<ArrayBufferLike>

Defined in: packages/server/dist/adapters/ws.d.mts:24

Encode data for transmission over the wire

Parameters

ParameterType
dataunknown

Returns

string | Uint8Array<ArrayBufferLike>