AvroSerializer

Defined in: src/serialization/AvroSerializer.ts:39

Avro Serializer — compact, schema-driven binary for a single type.

The schema library stays the user’s: pass a compiled avsc type (or anything with the same toBuffer/fromBuffer pair) and this class owns the parts that are easy to get wrong when wiring one up by hand — the Buffer coercion avsc needs on the read path (a plain Uint8Array, which is what base64 framing yields, throws deep inside the decoder), byte ownership, the manifest, and errors that name the serializer instead of surfacing a library-internal message.

import avsc from 'avsc';

const avroType = avsc.Type.forSchema({
  name: 'Deposited',
  type: 'record',
  fields: [{ name: 'amount', type: 'int' }],
});
const avroOptions = AvroSerializerOptions.create<Deposited>()
  .withAvroType(avroType)
  .withId(100);
const serializer = new AvroSerializer(avroOptions);

Reaches stored rows through a store’s withSerializer(...) (one format for the whole store) or, per (manifest, version), through serializerCodec(serializer) and the SchemaRegistry.

Stateless and safe to share: every method reads only the compiled type.

Type Parameters

T

T = unknown

Implements

Serializer<T>

Constructors

Constructor

new AvroSerializer<T>(options): AvroSerializer<T>

Defined in: src/serialization/AvroSerializer.ts:47

Parameters

options

AvroSerializerOptions<T>

Returns

AvroSerializer<T>

Properties

id

readonly id: number

Defined in: src/serialization/AvroSerializer.ts:40

Stable identifier that is embedded in every frame. Numbers 1..99 are reserved for the actor-ts built-ins (JSON=1, CBOR=2). User-defined serializers SHOULD use IDs ≥ RESERVED_SERIALIZER_IDS_BELOW.

Implementation of

Serializer.id

includesManifest

readonly includesManifest: boolean

Defined in: src/serialization/AvroSerializer.ts:42

True when this serializer is willing to encode the given value.

Implementation of

Serializer.includesManifest

name

readonly name: string

Defined in: src/serialization/AvroSerializer.ts:41

Human-readable name, surfaced in diagnostics.

Implementation of

Serializer.name

Methods

fromBinary()

fromBinary(bytes, manifest): T

Defined in: src/serialization/AvroSerializer.ts:70

Decode from binary. manifest is whatever was produced on the other side (or ” when the serializer does not use one).

Parameters

bytes

Uint8Array

manifest

string

Returns

T

Implementation of

Serializer.fromBinary

manifest()

manifest(_obj): string

Defined in: src/serialization/AvroSerializer.ts:60

Return a tag describing the concrete type of obj so the decoder knows how to reconstruct it. Typical values: class name, event ID, “map”, “null”, etc. May return an empty string for serializers that don’t need a manifest.