Partager via

Serializer interface

  • Référence
Paquet:
@azure/core-client

Utilisé pour mapper des objets de réponse brute aux formes finales. Permet d’empaquetage et de déballage des dates et d’autres types encodés qui ne sont pas intrinsèques à JSON. Autorise également l’extraction de valeurs à partir d’en-têtes, ainsi que l’insertion de valeurs et de constantes par défaut.

Propriétés

isXML

Indique si le contenu est XML ou non.
modelMappers

Mappeur de modèle fourni.

Méthodes

deserialize(Mapper, any, string, SerializerOptions)

Désérialisez l’objet donné en fonction de ses métadonnées définies dans le mappeur.
serialize(Mapper, any, string, SerializerOptions)

Sérialisez l’objet donné en fonction de ses métadonnées définies dans le mappeur.
validateConstraints(Mapper, any, string)

Valide les contraintes, le cas échéant. Cette fonction se lève si la valeur fournie ne respecte pas ces contraintes.

Détails de la propriété

isXML

Indique si le contenu est XML ou non.

isXML: boolean

Valeur de propriété

boolean

modelMappers

Mappeur de modèle fourni.

modelMappers: {[key: string]: any}

Valeur de propriété

{[key: string]: any}

Détails de la méthode

deserialize(Mapper, any, string, SerializerOptions)

Désérialisez l’objet donné en fonction de ses métadonnées définies dans le mappeur.

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

Paramètres

mapper
Mapper

Mappeur qui définit les métadonnées de l’objet sérialisable.

responseBody

any

Entité Javascript valide à désérialiser.

objectName

string

Nom de l’objet désérialisé.

options
SerializerOptions

Contrôle le comportement de l’analyseur et du générateur XML.

Retours

any

Objet Javascript désérialisé valide.

serialize(Mapper, any, string, SerializerOptions)

Sérialisez l’objet donné en fonction de ses métadonnées définies dans le mappeur.

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

Paramètres

mapper
Mapper

Mappeur qui définit les métadonnées de l’objet sérialisable.

object

any

Objet Javascript valide à sérialiser.

objectName

string

Nom de l’objet sérialisé.

options
SerializerOptions

options supplémentaires pour la désérialisation.

Retours

any

Objet Javascript sérialisé valide.

validateConstraints(Mapper, any, string)

Avertissement

Cette API est à présent déconseillée.

Removing the constraints validation on client side.

Valide les contraintes, le cas échéant. Cette fonction se lève si la valeur fournie ne respecte pas ces contraintes.

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

Paramètres

mapper
Mapper

Définition des modèles de données.

value

any

La valeur.

objectName

string

Nom de l'objet. Utilisé dans les messages d’erreur.