Serializer class

Paquete:

@azure/core-http

Se usa para asignar objetos de respuesta sin procesar a formas finales. Ayuda a empaquetar y desempaquetar fechas y otros tipos codificados que no son intrínsecos a JSON. También permite extraer valores de encabezados, así como insertar valores y constantes predeterminados.

Constructores

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

Propiedades

isXML	Si el contenido es XML o no.
modelMappers	Asignador de modelos proporcionado.

Métodos

deserialize(Mapper, unknown, string, SerializerOptions)	Deserialice el objeto especificado en función de sus metadatos definidos en el asignador.
serialize(Mapper, unknown, string, SerializerOptions)	Serialice el objeto especificado en función de sus metadatos definidos en el asignador.
validateConstraints(Mapper, unknown, string)	Valida las restricciones, si las hay. Esta función iniciará si el valor proporcionado no respeta esas restricciones.

Detalles del constructor

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

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

Parámetros

modelMappers

{[key: string]: any}

Asignador de modelos proporcionado.

isXML

boolean

Si el contenido es XML o no.

Detalles de las propiedades

isXML

Si el contenido es XML o no.

isXML?: boolean

Valor de propiedad

boolean

modelMappers

Asignador de modelos proporcionado.

modelMappers: {[key: string]: any}

Valor de propiedad

{[key: string]: any}

Detalles del método

deserialize(Mapper, unknown, string, SerializerOptions)

Deserialice el objeto especificado en función de sus metadatos definidos en el asignador.

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

Parámetros

mapper

Mapper

Asignador que define los metadatos del objeto serializable.

responseBody

unknown

Una entidad de Javascript válida que se va a deserializar.

objectName

string

Nombre del objeto deserializado.

options

SerializerOptions

Controla el comportamiento del analizador XML y del generador.

Devoluciones

any

Objeto JavaScript deserializado válido.

serialize(Mapper, unknown, string, SerializerOptions)

Serialice el objeto especificado en función de sus metadatos definidos en el asignador.

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

Parámetros

mapper

Mapper

Asignador que define los metadatos del objeto serializable.

object

unknown

Objeto JavaScript válido que se va a serializar.

objectName

string

Nombre del objeto serializado.

options

SerializerOptions

opciones adicionales para la deserialización.

Devoluciones

any

Objeto JavaScript serializado válido.

validateConstraints(Mapper, unknown, string)

Advertencia

Esta API ya está en desuso.

Removing the constraints validation on client side.

Valida las restricciones, si las hay. Esta función iniciará si el valor proporcionado no respeta esas restricciones.

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

Parámetros

mapper

Mapper

Definición de modelos de datos.

value

unknown

Valor.

objectName

string

Nombre del objeto. Se usa en los mensajes de error.