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

オブジェクト名。 エラー メッセージで使用されます。