JsonSchemaSerializer class

Serializador json que obtiene esquemas de un registro de esquema y no empaqueta esquemas en sus cargas.

Constructores

JsonSchemaSerializer<MessageT>(SchemaRegistry, JsonSchemaSerializerOptions<MessageT>)

Crea un nuevo serializador.

Métodos

deserialize<T>(MessageT, DeserializeOptions)

Deserializa la carga del mensaje mediante el identificador de esquema en el campo de tipo de contenido si no se proporcionó ningún esquema.

serialize(unknown, string)

serializa el parámetro value según el esquema de entrada y crea un mensaje con los datos serializados.

Detalles del constructor

JsonSchemaSerializer<MessageT>(SchemaRegistry, JsonSchemaSerializerOptions<MessageT>)

Crea un nuevo serializador.

new JsonSchemaSerializer(client: SchemaRegistry, options?: JsonSchemaSerializerOptions<MessageT>)

Parámetros

client
SchemaRegistry

Registro de esquemas donde se registran y obtienen esquemas. Normalmente se trata de una instancia SchemaRegistryClient.

options

JsonSchemaSerializerOptions<MessageT>

Detalles del método

deserialize<T>(MessageT, DeserializeOptions)

Deserializa la carga del mensaje mediante el identificador de esquema en el campo de tipo de contenido si no se proporcionó ningún esquema.

function deserialize<T>(message: MessageT, options?: DeserializeOptions): Promise<T>

Parámetros

message

MessageT

Mensaje con la carga que se va a deserializar.

Devoluciones

Promise<T>

Valor deserializado.

serialize(unknown, string)

serializa el parámetro value según el esquema de entrada y crea un mensaje con los datos serializados.

function serialize(value: unknown, schema: string): Promise<MessageT>

Parámetros

value

unknown

Valor que se va a serializar.

schema

string

Esquema Json que se va a usar.

Devoluciones

Promise<MessageT>

Nuevo mensaje con el valor serializado. La estructura del mensaje se constscribe mediante la opción generador de mensajes.