Serializer class

Paket:

@azure/core-http

Wird verwendet, um unformatierte Antwortobjekte endgültigen Shapes zuzuordnen. Hilft beim Packen und Entpacken von Datumsangaben und anderen codierten Typen, die nicht in JSON enthalten sind. Ermöglicht auch das Pullen von Werten aus Headern sowie das Einfügen von Standardwerten und Konstanten.

Konstruktoren

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

Eigenschaften

isXML	Gibt an, ob der Inhalt XML ist oder nicht.
modelMappers	Die bereitgestellte Modellzuordnung.

Methoden

deserialize(Mapper, unknown, string, SerializerOptions)	Deserialisieren Sie das angegebene Objekt basierend auf seinen Metadaten, die im Mapper definiert sind.
serialize(Mapper, unknown, string, SerializerOptions)	Serialisieren Sie das angegebene Objekt basierend auf seinen Metadaten, die im Mapper definiert sind.
validateConstraints(Mapper, unknown, string)	Überprüft Einschränkungen, falls vorhanden. Diese Funktion löst aus, wenn der angegebene Wert diese Einschränkungen nicht berücksichtigt.

Details zum Konstruktor

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

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

Parameter

modelMappers

{[key: string]: any}

Die bereitgestellte Modellzuordnung.

isXML

boolean

Gibt an, ob der Inhalt XML ist oder nicht.

Details zur Eigenschaft

isXML

Gibt an, ob der Inhalt XML ist oder nicht.

isXML?: boolean

Eigenschaftswert

boolean

modelMappers

Die bereitgestellte Modellzuordnung.

modelMappers: {[key: string]: any}

Eigenschaftswert

{[key: string]: any}

Details zur Methode

deserialize(Mapper, unknown, string, SerializerOptions)

Deserialisieren Sie das angegebene Objekt basierend auf seinen Metadaten, die im Mapper definiert sind.

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

Parameter

mapper

Mapper

Der Mapper, der die Metadaten des serialisierbaren Objekts definiert.

responseBody

unknown

Eine gültige Javascript-Entität, die deserialisiert werden soll.

objectName

string

Name des deserialisierten Objekts.

options

SerializerOptions

Steuert das Verhalten von XML-Parser und -Generatoren.

Gibt zurück

any

Ein gültiges deserialisiertes Javascript-Objekt.

serialize(Mapper, unknown, string, SerializerOptions)

Serialisieren Sie das angegebene Objekt basierend auf seinen Metadaten, die im Mapper definiert sind.

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

Parameter

mapper

Mapper

Der Mapper, der die Metadaten des serialisierbaren Objekts definiert.

object

unknown

Ein gültiges Javascript-Objekt, das serialisiert werden soll.

objectName

string

Name des serialisierten Objekts.

options

SerializerOptions

zusätzliche Optionen für die Deserialisierung.

Gibt zurück

any

Ein gültiges serialisiertes Javascript-Objekt.

validateConstraints(Mapper, unknown, string)

Warnung

Diese API ist nun veraltet.

Removing the constraints validation on client side.

Überprüft Einschränkungen, falls vorhanden. Diese Funktion löst aus, wenn der angegebene Wert diese Einschränkungen nicht berücksichtigt.

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

Parameter

mapper

Mapper

Die Definition von Datenmodellen.

value

unknown

Der Wert.

objectName

string

Name des Objekts. Wird in den Fehlermeldungen verwendet.