Skip to content
tRPC

Partners

Interface: Encoder

On this page

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

Encodes the messages a WebSocket server sends and decodes the ones it gets. The client's experimental_encoder must match.

Example

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

Decodes a received message.

Parameters

ParameterType
datastring | ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns

unknown


encode()

encode(data): string | Uint8Array<ArrayBuffer>

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

Encodes a message to send.

Parameters

ParameterType
dataunknown

Returns

string | Uint8Array<ArrayBuffer>