AvroSerializerOptionsType

AvroSerializerOptionsType<T> = object

Defined in: src/serialization/AvroSerializerOptions.ts:31

Plain options-object shape accepted by an AvroSerializer.

Type Parameters

T

T = unknown

Properties

avroType

readonly avroType: AvroType<T>

Defined in: src/serialization/AvroSerializerOptions.ts:33

The compiled Avro type that does the encoding. Required.

---

id

readonly id: number

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

Wire identifier embedded in every frame. Required, and must be

= 100: 1–99 are reserved for the built-ins (JSON=1, CBOR=2), and a collision there is only noticed when a reader decodes garbage.

---

manifest?

readonly optional manifest?: string

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

Manifest written alongside the bytes. Defaults to the Avro type’s record name, so a decoder can tell a Deposited row from a Withdrawn one; set '' to write no manifest at all.

---

name?

readonly optional name?: string

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

Diagnostic name shown in error messages. Default 'avro'.