Serializer interface
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.
Propriedades
isXML | Se o conteúdo é XML ou não. |
model |
O mapeador de modelo fornecido. |
Métodos
deserialize(Mapper, any, string, Serializer |
Desserialize o objeto fornecido com base em seus metadados definidos no mapeador. |
serialize(Mapper, any, string, Serializer |
Serialize o objeto fornecido com base em seus metadados definidos no mapeador. |
validate |
Valida restrições, se houver. Essa função será gerada se o valor fornecido não respeitar essas restrições. |
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, any, string, SerializerOptions)
Desserialize o objeto fornecido com base em seus metadados definidos no mapeador.
function deserialize(mapper: Mapper, responseBody: any, objectName: string, options?: SerializerOptions): any
Parâmetros
- mapper
- Mapper
O mapeador que define os metadados do objeto serializável.
- responseBody
-
any
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, any, string, SerializerOptions)
Serialize o objeto fornecido com base em seus metadados definidos no mapeador.
function serialize(mapper: Mapper, object: any, objectName?: string, options?: SerializerOptions): any
Parâmetros
- mapper
- Mapper
O mapeador que define os metadados do objeto serializável.
- object
-
any
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, any, 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: any, objectName: string)
Parâmetros
- mapper
- Mapper
A definição de modelos de dados.
- value
-
any
O valor.
- objectName
-
string
Nome do objeto. Usado nas mensagens de erro.