EventGridDeserializer class
EventGridDeserializer 用于帮助处理 EventGrid 传递的事件。 它可以反序列化单个事件或一批事件的 JSON 编码有效负载,以及用于将 JSON.parse
的结果转换为 EventGridEvent
或 CloudEvent
等对象。
与常规 JSON 反序列化不同,EventGridDeserializer 执行一些其他转换:
- 使用者将事件时间属性分析为
Date
对象,以便于使用。 - 在 CloudEvent 架构中反序列化事件时,如果事件包含二进制数据,则它是 base64 解码的,并作为
Uint8Array
类型的实例返回。
方法
deserialize |
反序列化在云事件 1.0 架构中编码的事件。 |
deserialize |
反序列化在云事件 1.0 架构中编码的事件。 |
deserialize |
反序列化在事件网格架构中编码的事件。 |
deserialize |
反序列化在事件网格架构中编码的事件。 |
方法详细信息
deserializeCloudEvents(Record<string, unknown>)
反序列化在云事件 1.0 架构中编码的事件。
function deserializeCloudEvents(encodedEvents: Record<string, unknown>): Promise<CloudEvent<unknown>[]>
参数
- encodedEvents
-
Record<string, unknown>
表示单个事件的对象,在 Cloud Events 1.0 架构中编码。
返回
Promise<CloudEvent<unknown>[]>
deserializeCloudEvents(string)
反序列化在云事件 1.0 架构中编码的事件。
function deserializeCloudEvents(encodedEvents: string): Promise<CloudEvent<unknown>[]>
参数
- encodedEvents
-
string
在云事件 1.0 架构中编码的单个事件或事件数组的 JSON 编码表示形式。
返回
Promise<CloudEvent<unknown>[]>
deserializeEventGridEvents(Record<string, unknown>)
反序列化在事件网格架构中编码的事件。
function deserializeEventGridEvents(encodedEvents: Record<string, unknown>): Promise<EventGridEvent<unknown>[]>
参数
- encodedEvents
-
Record<string, unknown>
一个对象,表示在事件网格架构中编码的单个事件。
返回
Promise<EventGridEvent<unknown>[]>
deserializeEventGridEvents(string)
反序列化在事件网格架构中编码的事件。
function deserializeEventGridEvents(encodedEvents: string): Promise<EventGridEvent<unknown>[]>
参数
- encodedEvents
-
string
事件网格架构中编码的单个事件或事件数组的 JSON 编码表示形式。
返回
Promise<EventGridEvent<unknown>[]>