Serializer interface

套件:

@azure/core-client

用來將原始回應對象對應至最終圖形。 協助封裝和解壓縮日期和其他不是 JSON 內建的編碼類型。 也允許從標頭提取值，以及插入預設值和常數。

屬性

isXML	內容是否為 XML。
modelMappers	提供的模型對應程式。

方法

deserialize(Mapper, any, string, SerializerOptions)	根據對應程式中所定義的元數據，還原串行化指定的物件。
serialize(Mapper, any, string, SerializerOptions)	根據對應程式中所定義的元數據，串行化指定的物件。
validateConstraints(Mapper, any, string)	驗證條件約束，如果有的話。 如果提供的 值不符合這些條件約束，此函式將會擲回。

屬性詳細資料

isXML

內容是否為 XML。

isXML: boolean

屬性值

boolean

modelMappers

提供的模型對應程式。

modelMappers: {[key: string]: any}

屬性值

{[key: string]: any}

方法詳細資料

deserialize(Mapper, any, string, SerializerOptions)

根據對應程式中所定義的元數據，還原串行化指定的物件。

function deserialize(mapper: Mapper, responseBody: any, objectName: string, options?: SerializerOptions): any

參數

mapper

Mapper

定義可串行化物件的元數據的對應程式。

responseBody

any

要還原串行化的有效 Javascript 實體。

objectName

string

還原串行化對象的名稱。

options

SerializerOptions

控制 XML 剖析器和產生器的行為。

傳回

any

有效的還原串行化 Javascript 物件。

serialize(Mapper, any, string, SerializerOptions)

根據對應程式中所定義的元數據，串行化指定的物件。

function serialize(mapper: Mapper, object: any, objectName?: string, options?: SerializerOptions): any

參數

mapper

Mapper

定義可串行化物件的元數據的對應程式。

object

any

要串行化的有效 Javascript 物件。

objectName

string

串行化對象的名稱。

options

SerializerOptions

還原串行化的其他選項。

傳回

any

有效的串行化 Javascript 物件。

validateConstraints(Mapper, any, string)

警告

此 API 現已淘汰。

Removing the constraints validation on client side.

驗證條件約束，如果有的話。 如果提供的 值不符合這些條件約束，此函式將會擲回。

function validateConstraints(mapper: Mapper, value: any, objectName: string)

參數

mapper

Mapper

數據模型的定義。

value

any

值。

objectName

string

物件的名稱。 用於錯誤訊息中。