Interface: Encoder

Defined in: packages/server/src/adapters/wsEncoder.ts:13

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/src/adapters/wsEncoder.ts:17

Decode data received from the wire

Parameters

Parameter	Type
data	string | ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns

unknown

---

encode()

encode(data): string | Uint8Array<ArrayBufferLike>

Defined in: packages/server/src/adapters/wsEncoder.ts:15

Encode data for transmission over the wire

Parameters

Parameter	Type
data	unknown

Returns

string | Uint8Array<ArrayBufferLike>