Serializer class

Pacote:

@azure/core-http

Usado para mapear objetos de resposta brutos para formas finais. Ajuda a empacotar e desempacotar Datas e outros tipos codificados que não são intrínsecos ao JSON. Também permite extrair valores de cabeçalhos, bem como inserir valores e constantes padrão.

Construtores

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

Propriedades

isXML	Se o conteúdo é XML ou não.
modelMappers	O mapeador de modelo fornecido.

Métodos

deserialize(Mapper, unknown, string, SerializerOptions)	Desserialize o objeto fornecido com base em seus metadados definidos no mapeador.
serialize(Mapper, unknown, string, SerializerOptions)	Serialize o objeto fornecido com base em seus metadados definidos no mapeador.
validateConstraints(Mapper, unknown, string)	Valida restrições, se houver. Essa função será gerada se o valor fornecido não respeitar essas restrições.

Detalhes do construtor

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

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

Parâmetros

modelMappers

{[key: string]: any}

O mapeador de modelo fornecido.

isXML

boolean

Se o conteúdo é XML ou não.

Detalhes da propriedade

isXML

Se o conteúdo é XML ou não.

isXML?: boolean

Valor da propriedade

boolean

modelMappers

O mapeador de modelo fornecido.

modelMappers: {[key: string]: any}

Valor da propriedade

{[key: string]: any}

Detalhes do método

deserialize(Mapper, unknown, string, SerializerOptions)

Desserialize o objeto fornecido com base em seus metadados definidos no mapeador.

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

Parâmetros

mapper

Mapper

O mapeador que define os metadados do objeto serializável.

responseBody

unknown

Uma entidade Javascript válida a ser desserializada.

objectName

string

Nome do objeto desserializado.

options

SerializerOptions

Controla o comportamento do analisador e do construtor XML.

Retornos

any

Um objeto Javascript desserializado válido.

serialize(Mapper, unknown, string, SerializerOptions)

Serialize o objeto fornecido com base em seus metadados definidos no mapeador.

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

Parâmetros

mapper

Mapper

O mapeador que define os metadados do objeto serializável.

object

unknown

Um objeto Javascript válido a ser serializado.

objectName

string

Nome do objeto serializado.

options

SerializerOptions

opções adicionais para desserialização.

Retornos

any

Um objeto Javascript serializado válido.

validateConstraints(Mapper, unknown, string)

Aviso

Essa API foi preterida.

Removing the constraints validation on client side.

Valida restrições, se houver. Essa função será gerada se o valor fornecido não respeitar essas restrições.

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

Parâmetros

mapper

Mapper

A definição de modelos de dados.

value

unknown

O valor.

objectName

string

Nome do objeto. Usado nas mensagens de erro.