Partilhar via


Serializer class

Utilizado para mapear objetos de resposta não processados 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 predefinidos.

Construtores

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

Propriedades

isXML

Quer os conteúdos sejam ou não XML.

modelMappers

O mapeador de modelos fornecido.

Métodos

deserialize(Mapper, unknown, string, SerializerOptions)

Anular a serialização do objeto especificado com base nos metadados definidos no mapeador.

serialize(Mapper, unknown, string, SerializerOptions)

Serialize o objeto especificado com base nos metadados definidos no mapeador.

validateConstraints(Mapper, unknown, string)

Valida as restrições, se existirem. Esta função será emitida 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 modelos fornecido.

isXML

boolean

Quer os conteúdos sejam ou não XML.

Detalhes de Propriedade

isXML

Quer os conteúdos sejam ou não XML.

isXML?: boolean

Valor de Propriedade

boolean

modelMappers

O mapeador de modelos fornecido.

modelMappers: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

Detalhes de Método

deserialize(Mapper, unknown, string, SerializerOptions)

Anular a serialização do objeto especificado com base nos 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 XML e do construtor.

Devoluções

any

Um objeto Javascript deserializado válido.

serialize(Mapper, unknown, string, SerializerOptions)

Serialize o objeto especificado com base nos 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 a desserialização.

Devoluções

any

Um objeto Javascript serializado válido.

validateConstraints(Mapper, unknown, string)

Aviso

Esta API foi preterida.

Removing the constraints validation on client side.

Valida as restrições, se existirem. Esta função será emitida 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. Utilizado nas mensagens de erro.