Serializer class

Пакет:

@azure/core-http

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

Конструкторы

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

Свойства

isXML	Указывает, является ли содержимое XML или нет.
modelMappers	Предоставленный сопоставителя моделей.

Методы

deserialize(Mapper, unknown, string, SerializerOptions)	Десериализируйте заданный объект на основе его метаданных, определенных в сопоставителях.
serialize(Mapper, unknown, string, SerializerOptions)	Сериализация заданного объекта на основе его метаданных, определенных в сопоставителях.
validateConstraints(Mapper, unknown, string)	Проверяет ограничения, если таковые есть. Эта функция вызывает исключение, если указанное значение не учитывает эти ограничения.

Сведения о конструкторе

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

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

Параметры

modelMappers

{[key: string]: any}

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

isXML

boolean

Указывает, является ли содержимое XML или нет.

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

isXML

Указывает, является ли содержимое XML или нет.

isXML?: boolean

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

boolean

modelMappers

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

modelMappers: {[key: string]: any}

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

{[key: string]: any}

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

deserialize(Mapper, unknown, string, SerializerOptions)

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

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

Параметры

mapper

Mapper

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

responseBody

unknown

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

objectName

string

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

options

SerializerOptions

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

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

any

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

serialize(Mapper, unknown, string, SerializerOptions)

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

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

Параметры

mapper

Mapper

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

object

unknown

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

objectName

string

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

options

SerializerOptions

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

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

any

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

validateConstraints(Mapper, unknown, string)

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

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

Removing the constraints validation on client side.

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

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

Параметры

mapper

Mapper

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

value

unknown

Значение.

objectName

string

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