Serializer class

Пакет:

@azure/core-http

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

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

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

Свойства

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

Методы

deserialize(Mapper, unknown, string, SerializerOptions)	Десериализация данного объекта на основе метаданных, определенных в mapper.
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)

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

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

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