Serializer class

Balíček:

@azure/core-http

Slouží k mapování nezpracovaných objektů odpovědi na konečné obrazce. Pomáhá balit a rozbalovat kalendářní data a další kódované typy, které nejsou vnitřní pro JSON. Umožňuje také načítání hodnot ze záhlaví a vkládání výchozích hodnot a konstant.

Konstruktory

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

Vlastnosti

isXML	Bez ohledu na to, jestli je obsah XML nebo ne.
modelMappers	Zadaný mapovač modelu.

Metody

deserialize(Mapper, unknown, string, SerializerOptions)	Deserializace daného objektu na základě jeho metadat definovaných v mapperu.
serialize(Mapper, unknown, string, SerializerOptions)	Serializace daného objektu na základě jeho metadat definovaných v mapperu.
validateConstraints(Mapper, unknown, string)	Ověří omezení, pokud existuje. Tato funkce se vyvolá, pokud zadaná hodnota nerespektuje tato omezení.

Podrobnosti konstruktoru

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

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

Parametry

modelMappers

{[key: string]: any}

Zadaný mapovač modelu.

isXML

boolean

Bez ohledu na to, jestli je obsah XML nebo ne.

Podrobnosti vlastnosti

isXML

Bez ohledu na to, jestli je obsah XML nebo ne.

isXML?: boolean

Hodnota vlastnosti

boolean

modelMappers

Zadaný mapovač modelu.

modelMappers: {[key: string]: any}

Hodnota vlastnosti

{[key: string]: any}

Podrobnosti metody

deserialize(Mapper, unknown, string, SerializerOptions)

Deserializace daného objektu na základě jeho metadat definovaných v mapperu.

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

Parametry

mapper

Mapper

Mapovač, který definuje metadata serializovatelného objektu.

responseBody

unknown

Platná javascriptová entita, která se má deserializovat.

objectName

string

Název deserializovaného objektu.

options

SerializerOptions

Řídí chování analyzátoru a tvůrce XML.

Návraty

any

Platný deserializovaný javascriptový objekt.

serialize(Mapper, unknown, string, SerializerOptions)

Serializace daného objektu na základě jeho metadat definovaných v mapperu.

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

Parametry

mapper

Mapper

Mapovač, který definuje metadata serializovatelného objektu.

object

unknown

Platný javascriptový objekt, který se má serializovat.

objectName

string

Název serializovaného objektu.

options

SerializerOptions

další možnosti deserializace.

Návraty

any

Platný serializovaný javascriptový objekt.

validateConstraints(Mapper, unknown, string)

Upozornění

Toto rozhraní API je teď zastaralé.

Removing the constraints validation on client side.

Ověří omezení, pokud existuje. Tato funkce se vyvolá, pokud zadaná hodnota nerespektuje tato omezení.

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

Parametry

mapper

Mapper

Definice datových modelů

value

unknown

Hodnota.

objectName

string

Název objektu. Používá se v chybových zprávách.