Condividi tramite

Serializer class

  • Riferimento
Pacchetto:
@azure/core-http

Utilizzato per eseguire il mapping degli oggetti risposta non elaborati alle forme finali. Consente di creare pacchetti e decomprimere date e altri tipi codificati che non sono intrinseci a JSON. Consente anche il pull di valori dalle intestazioni, nonché l'inserimento di valori e costanti predefiniti.

Costruttori

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

Proprietà

isXML

Indica se il contenuto è XML o meno.
modelMappers

Mapper del modello fornito.

Metodi

deserialize(Mapper, unknown, string, SerializerOptions)

Deserializzare l'oggetto specificato in base ai metadati definiti nel mapper.
serialize(Mapper, unknown, string, SerializerOptions)

Serializzare l'oggetto specificato in base ai metadati definiti nel mapper.
validateConstraints(Mapper, unknown, string)

Convalida i vincoli, se presenti. Questa funzione genererà se il valore specificato non rispetta tali vincoli.

Dettagli costruttore

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

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

Parametri

modelMappers

{[key: string]: any}

Mapper del modello fornito.

isXML

boolean

Indica se il contenuto è XML o meno.

Dettagli proprietà

isXML

Indica se il contenuto è XML o meno.

isXML?: boolean

Valore della proprietà

boolean

modelMappers

Mapper del modello fornito.

modelMappers: {[key: string]: any}

Valore della proprietà

{[key: string]: any}

Dettagli metodo

deserialize(Mapper, unknown, string, SerializerOptions)

Deserializzare l'oggetto specificato in base ai metadati definiti nel mapper.

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

Parametri

mapper
Mapper

Mapper che definisce i metadati dell'oggetto serializzabile.

responseBody

unknown

Entità Javascript valida da deserializzare.

objectName

string

Nome dell'oggetto deserializzato.

options
SerializerOptions

Controlla il comportamento del parser e del generatore XML.

Restituisce

any

Oggetto Javascript deserializzato valido.

serialize(Mapper, unknown, string, SerializerOptions)

Serializzare l'oggetto specificato in base ai metadati definiti nel mapper.

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

Parametri

mapper
Mapper

Mapper che definisce i metadati dell'oggetto serializzabile.

object

unknown

Oggetto Javascript valido da serializzare.

objectName

string

Nome dell'oggetto serializzato.

options
SerializerOptions

opzioni aggiuntive per la deserializzazione.

Restituisce

any

Oggetto Javascript serializzato valido.

validateConstraints(Mapper, unknown, string)

Avviso

Questa API è ora deprecata.

Removing the constraints validation on client side.

Convalida i vincoli, se presenti. Questa funzione genererà se il valore specificato non rispetta tali vincoli.

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

Parametri

mapper
Mapper

Definizione dei modelli di dati.

value

unknown

Valore.

objectName

string

Nome dell'oggetto. Usato nei messaggi di errore.