Udostępnij za pośrednictwem

Serializer interface

  • Odwołanie
Pakiet:
@azure/core-client

Służy do mapowania nieprzetworzonych obiektów odpowiedzi na końcowe kształty. Ułatwia pakowanie i rozpakowywanie dat oraz innych zakodowanych typów, które nie są wewnętrzne w formacie JSON. Umożliwia również ściąganie wartości z nagłówków, a także wstawianie wartości domyślnych i stałych.

Właściwości

isXML

Niezależnie od tego, czy zawartość jest plikiem XML, czy nie.
modelMappers

Podany maper modelu.

Metody

deserialize(Mapper, any, string, SerializerOptions)

Deserializuj dany obiekt na podstawie jego metadanych zdefiniowanych w mapie.
serialize(Mapper, any, string, SerializerOptions)

Serializuj dany obiekt na podstawie jego metadanych zdefiniowanych w mapie.
validateConstraints(Mapper, any, string)

Weryfikuje ograniczenia, jeśli istnieją. Ta funkcja zwróci wartość, jeśli podana wartość nie spełnia tych ograniczeń.

Szczegóły właściwości

isXML

Niezależnie od tego, czy zawartość jest plikiem XML, czy nie.

isXML: boolean

Wartość właściwości

boolean

modelMappers

Podany maper modelu.

modelMappers: {[key: string]: any}

Wartość właściwości

{[key: string]: any}

Szczegóły metody

deserialize(Mapper, any, string, SerializerOptions)

Deserializuj dany obiekt na podstawie jego metadanych zdefiniowanych w mapie.

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

Parametry

mapper
Mapper

Maper, który definiuje metadane obiektu możliwego do serializacji.

responseBody

any

Prawidłowa jednostka javascript do deserializacji.

objectName

string

Nazwa zdeserializowanego obiektu.

options
SerializerOptions

Steruje zachowaniem analizatora XML i konstruktora.

Zwraca

any

Prawidłowy zdeserializowany obiekt JavaScript.

serialize(Mapper, any, string, SerializerOptions)

Serializuj dany obiekt na podstawie jego metadanych zdefiniowanych w mapie.

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

Parametry

mapper
Mapper

Maper, który definiuje metadane obiektu możliwego do serializacji.

object

any

Prawidłowy obiekt JavaScript do serializacji.

objectName

string

Nazwa serializowanego obiektu.

options
SerializerOptions

dodatkowe opcje deserializacji.

Zwraca

any

Prawidłowy serializowany obiekt Javascript.

validateConstraints(Mapper, any, string)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Removing the constraints validation on client side.

Weryfikuje ograniczenia, jeśli istnieją. Ta funkcja zwróci wartość, jeśli podana wartość nie spełnia tych ograniczeń.

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

Parametry

mapper
Mapper

Definicja modeli danych.

value

any

Wartość.

objectName

string

Nazwa obiektu. Używane w komunikatach o błędach.