Skip to main content

Codec

@horizon-republic/nestjs-jetstream

@horizon-republic/nestjs-jetstream / Codec

Codec

Defined in: src/interfaces/codec.interface.ts:22

Codec interface for encoding and decoding message payloads.

Implementations handle serialization between application objects and binary data transmitted over NATS. The transport uses a single global codec: all messages (RPC and events) share the same format.

Example​

import { encode, decode } from '@msgpack/msgpack';

class MsgPackCodec implements Codec {
  encode(data: unknown): Uint8Array {
    return encode(data);
  }
  decode(data: Uint8Array): unknown {
    return decode(data);
  }
}

Methods​

decode()​

decode(data): unknown

Defined in: src/interfaces/codec.interface.ts:27

Deserialize binary NATS payload back to application data.

Parameters​

data​

Uint8Array

Returns​

unknown

encode()​

encode(data): Uint8Array

Defined in: src/interfaces/codec.interface.ts:24

Serialize application data to binary for NATS transmission.

Parameters​

data​

unknown

Returns​

Uint8Array