Sdílet prostřednictvím

Serializer class

  • Reference
Balíček:
@azure/core-http

Slouží k mapování objektů nezpracovaných odpovědí na konečné obrazce. Pomáhá balit a rozbalovat data a další zakó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

Určuje, jestli je obsah XML, nebo ne.
modelMappers

Zadaný mapovač modelu.

Metody

deserialize(Mapper, unknown, string, SerializerOptions)

Deserializovat daný objekt na základě jeho metadat definovaných v mapovači.
serialize(Mapper, unknown, string, SerializerOptions)

Serializujte daný objekt na základě jeho metadat definovaných v mapovači.
validateConstraints(Mapper, unknown, string)

Ověří případná omezení. Tato funkce vyvolá výjimku, pokud zadaná hodnota tato omezení nerespektuje.

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

Určuje, jestli je obsah XML, nebo ne.

Podrobnosti vlastnosti

isXML

Určuje, 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)

Deserializovat daný objekt na základě jeho metadat definovaných v mapovači.

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á má být deserializována.

objectName

string

Název deserializovaného objektu.

options
SerializerOptions

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

Návraty

any

Platný deserializovaný objekt Jazyka JavaScript.

serialize(Mapper, unknown, string, SerializerOptions)

Serializujte daný objekt na základě jeho metadat definovaných v mapovači.

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

Parametry

mapper
Mapper

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

object

unknown

Platný objekt javascriptu, který má být serializován.

objectName

string

Název serializovaného objektu.

options
SerializerOptions

další možnosti deserializace.

Návraty

any

Platný serializovaný javascript objekt.

validateConstraints(Mapper, unknown, string)

Upozornění

Toto rozhraní API je teď zastaralé.

Removing the constraints validation on client side.

Ověří případná omezení. Tato funkce vyvolá výjimku, pokud zadaná hodnota tato omezení nerespektuje.

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.