Serializer interface

  • Ссылка
Пакет:
@azure/core-client

Используется для сопоставления необработанных объектов ответа с конечными фигурами. Помогает упаковывать и распаковывать даты и другие закодированные типы, которые не являются встроенными в JSON. Также позволяет извлекать значения из заголовков, а также вставлять значения и константы по умолчанию.

Свойства

isXML

Является ли содержимое XML или нет.
modelMappers

Предоставленный сопоставителя моделей.

Методы

deserialize(Mapper, any, string, SerializerOptions)

Десериализируйте заданный объект на основе его метаданных, определенных в сопоставителях.
serialize(Mapper, any, string, SerializerOptions)

Сериализация заданного объекта на основе его метаданных, определенных в сопоставителях.
validateConstraints(Mapper, any, string)

Проверяет ограничения, если таковые есть. Эта функция вызывает исключение, если указанное значение не соответствует этим ограничениям.

Сведения о свойстве

isXML

Является ли содержимое XML или нет.

isXML: boolean

Значение свойства

boolean

modelMappers

Предоставленный сопоставителя моделей.

modelMappers: {[key: string]: any}

Значение свойства

{[key: string]: any}

Сведения о методе

deserialize(Mapper, any, string, SerializerOptions)

Десериализируйте заданный объект на основе его метаданных, определенных в сопоставителях.

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

Параметры

mapper
Mapper

Сопоставителя, который определяет метаданные сериализуемого объекта.

responseBody

any

Допустимая десериализуемая сущность JavaScript.

objectName

string

Имя десериализованного объекта.

options
SerializerOptions

Управляет поведением средства синтаксического анализа и построителя XML.

Возвращаемое значение

any

Допустимый десериализованный объект JavaScript.

serialize(Mapper, any, string, SerializerOptions)

Сериализация заданного объекта на основе его метаданных, определенных в сопоставителях.

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

Параметры

mapper
Mapper

Сопоставителя, который определяет метаданные сериализуемого объекта.

object

any

Допустимый объект JavaScript для сериализации.

objectName

string

Имя сериализованного объекта.

options
SerializerOptions

дополнительные параметры десериализации.

Возвращаемое значение

any

Допустимый сериализованный объект JavaScript.

validateConstraints(Mapper, any, string)

Предупреждение

Теперь этот API является нерекомендуемым.

Removing the constraints validation on client side.

Проверяет ограничения, если таковые есть. Эта функция вызывает исключение, если указанное значение не соответствует этим ограничениям.

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

Параметры

mapper
Mapper

Определение моделей данных.

value

any

Значение.

objectName

string

Имя объекта. Используется в сообщениях об ошибках.