Class SchemaRegistryAvroSerializer

Package version

Avro serializer that obtains schemas from a schema registry and does not pack schemas into its payloads.

Hierarchy

SchemaRegistryAvroSerializer

Index

Constructors

constructor

Methods

Constructors

constructor

new SchemaRegistryAvroSerializer(registry: SchemaRegistry, schemaGroup: string, options?: SchemaRegistryAvroSerializerOptions): SchemaRegistryAvroSerializer

- Defined in schemaRegistryAvroSerializer.ts:64
Creates a new serializer.

Parameters
- registry: SchemaRegistry
  
  Schema Registry where schemas are registered and obtained. Usually this is a SchemaRegistryClient instance.
- schemaGroup: string
  
  The schema group to use when making requests to the registry.
- Optional options: SchemaRegistryAvroSerializerOptions
Returns SchemaRegistryAvroSerializer

Methods

deserialize

deserialize<T>(buffer: Buffer): Promise<T>

- Defined in schemaRegistryAvroSerializer.ts:135
Deserializes a value from a buffer.

Type parameters
- T
Parameters
- buffer: Buffer
  
  The buffer with the serialized value.
Returns Promise<T>

The deserialized value.

serialize

serialize(value: any, schema: string): Promise<Buffer>

- Defined in schemaRegistryAvroSerializer.ts:117
Serializes a value into a buffer.

Parameters
- value: any
  
  The value to serialize.
- schema: string
  
  The Avro schema to use.
Returns Promise<Buffer>

A new buffer with the serialized value

Generated using TypeDoc