共用方式為


Serializer class

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

建構函式

Serializer({[key: string]: any}, boolean)

屬性

isXML

內容是否為 XML。

modelMappers

提供的模型對應器。

方法

deserialize(Mapper, unknown, string, SerializerOptions)

根據對應器中定義的中繼資料,還原序列化指定的物件。

serialize(Mapper, unknown, string, SerializerOptions)

根據對應器中定義的中繼資料序列化指定的物件。

validateConstraints(Mapper, unknown, string)

驗證條件約束,如果有的話。 如果提供的值未遵守這些條件約束,此函式將會擲回。

建構函式詳細資料

Serializer({[key: string]: any}, boolean)

new Serializer(modelMappers?: {[key: string]: any}, isXML?: boolean)

參數

modelMappers

{[key: string]: any}

提供的模型對應器。

isXML

boolean

內容是否為 XML。

屬性詳細資料

isXML

內容是否為 XML。

isXML?: boolean

屬性值

boolean

modelMappers

提供的模型對應器。

modelMappers: {[key: string]: any}

屬性值

{[key: string]: any}

方法詳細資料

deserialize(Mapper, unknown, string, SerializerOptions)

根據對應器中定義的中繼資料,還原序列化指定的物件。

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

參數

mapper
Mapper

定義可序列化物件的中繼資料的對應器。

responseBody

unknown

要還原序列化的有效 JAVAscript 實體。

objectName

string

已還原序列化物件的名稱。

options
SerializerOptions

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

傳回

any

有效的還原序列化 JAVAscript 物件。

serialize(Mapper, unknown, string, SerializerOptions)

根據對應器中定義的中繼資料序列化指定的物件。

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

參數

mapper
Mapper

定義可序列化物件的中繼資料的對應器。

object

unknown

要序列化的有效 JAVAscript 物件。

objectName

string

序列化物件的名稱。

options
SerializerOptions

還原序列化的其他選項。

傳回

any

有效的序列化 JAVAscript 物件。

validateConstraints(Mapper, unknown, string)

警告

此 API 現已淘汰。

Removing the constraints validation on client side.

驗證條件約束,如果有的話。 如果提供的值未遵守這些條件約束,此函式將會擲回。

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

參數

mapper
Mapper

資料模型的定義。

value

unknown

數值。

objectName

string

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