Compartilhar via

EventGridDeserializer class

Pacote:
@azure/eventgrid

EventGridDeserializer é usado para ajudar no processamento de eventos entregues pelo EventGrid. Ele pode desserializar uma carga codificada em JSON de um único evento ou lote de eventos, bem como ser usado para converter o resultado de JSON.parse em uma EventGridEvent ou CloudEvent como objeto.

Ao contrário da desserialização JSON normal, EventGridDeserializer faz algumas conversões adicionais:

  • O consumidor analisa a propriedade de hora do evento em um objeto Date, para facilitar o uso.
  • Ao desserializar um evento no esquema CloudEvent, se o evento contiver dados binários, ele será decodificado e retornado como uma instância do tipo Uint8Array.

Métodos

deserializeCloudEvents(Record<string, unknown>)

Desserializa eventos codificados no esquema eventos de nuvem 1.0.
deserializeCloudEvents(string)

Desserializa eventos codificados no esquema eventos de nuvem 1.0.
deserializeEventGridEvents(Record<string, unknown>)

Desserializa eventos codificados no esquema da Grade de Eventos.
deserializeEventGridEvents(string)

Desserializa eventos codificados no esquema da Grade de Eventos.

Detalhes do método

deserializeCloudEvents(Record<string, unknown>)

Desserializa eventos codificados no esquema eventos de nuvem 1.0.

function deserializeCloudEvents(encodedEvents: Record<string, unknown>): Promise<CloudEvent<unknown>[]>

Parâmetros

encodedEvents

Record<string, unknown>

um objeto que representa um único evento, codificado no esquema eventos de nuvem 1.0.

Retornos

Promise<CloudEvent<unknown>[]>

deserializeCloudEvents(string)

Desserializa eventos codificados no esquema eventos de nuvem 1.0.

function deserializeCloudEvents(encodedEvents: string): Promise<CloudEvent<unknown>[]>

Parâmetros

encodedEvents

string

a representação codificada em JSON de um único evento ou uma matriz de eventos, codificada no Esquema de Eventos de Nuvem 1.0.

Retornos

Promise<CloudEvent<unknown>[]>

deserializeEventGridEvents(Record<string, unknown>)

Desserializa eventos codificados no esquema da Grade de Eventos.

function deserializeEventGridEvents(encodedEvents: Record<string, unknown>): Promise<EventGridEvent<unknown>[]>

Parâmetros

encodedEvents

Record<string, unknown>

um objeto que representa um único evento, codificado no esquema da Grade de Eventos.

Retornos

Promise<EventGridEvent<unknown>[]>

deserializeEventGridEvents(string)

Desserializa eventos codificados no esquema da Grade de Eventos.

function deserializeEventGridEvents(encodedEvents: string): Promise<EventGridEvent<unknown>[]>

Parâmetros

encodedEvents

string

a representação codificada em JSON de um único evento ou uma matriz de eventos, codificada no Esquema de Grade de Eventos.

Retornos

Promise<EventGridEvent<unknown>[]>