Partager via

EventGridDeserializer class

  • Référence
Paquet:
@azure/eventgrid

EventGridDeserializer est utilisé pour faciliter le traitement des événements remis par EventGrid. Il peut désérialiser une charge utile encodée JSON d’un événement unique ou d’un lot d’événements, ainsi que pour convertir le résultat de JSON.parse en un EventGridEvent ou CloudEvent comme objet.

Contrairement à la désérialisation JSON normale, EventGridDeserializer effectue certaines conversions supplémentaires :

  • Le consommateur analyse la propriété d’heure d’événement dans un objet Date, pour faciliter l’utilisation.
  • Lors de la désérialisation d’un événement dans le schéma CloudEvent, si l’événement contient des données binaires, il est décodé en base64 et retourné en tant qu’instance du type Uint8Array.

Méthodes

deserializeCloudEvents(Record<string, unknown>)

Désérialise les événements encodés dans le schéma Cloud Events 1.0.
deserializeCloudEvents(string)

Désérialise les événements encodés dans le schéma Cloud Events 1.0.
deserializeEventGridEvents(Record<string, unknown>)

Désérialise les événements encodés dans le schéma Event Grid.
deserializeEventGridEvents(string)

Désérialise les événements encodés dans le schéma Event Grid.

Détails de la méthode

deserializeCloudEvents(Record<string, unknown>)

Désérialise les événements encodés dans le schéma Cloud Events 1.0.

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

Paramètres

encodedEvents

Record<string, unknown>

objet représentant un seul événement, encodé dans le schéma Cloud Events 1.0.

Retours

Promise<CloudEvent<unknown>[]>

deserializeCloudEvents(string)

Désérialise les événements encodés dans le schéma Cloud Events 1.0.

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

Paramètres

encodedEvents

string

représentation encodée JSON d’un événement unique ou d’un tableau d’événements, encodée dans le schéma Cloud Events 1.0.

Retours

Promise<CloudEvent<unknown>[]>

deserializeEventGridEvents(Record<string, unknown>)

Désérialise les événements encodés dans le schéma Event Grid.

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

Paramètres

encodedEvents

Record<string, unknown>

objet représentant un événement unique, encodé dans le schéma Event Grid.

Retours

Promise<EventGridEvent<unknown>[]>

deserializeEventGridEvents(string)

Désérialise les événements encodés dans le schéma Event Grid.

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

Paramètres

encodedEvents

string

représentation encodée JSON d’un événement unique ou d’un tableau d’événements, encodée dans le schéma Event Grid.

Retours

Promise<EventGridEvent<unknown>[]>