Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Serializer

Package version

Hierarchy

  • Serializer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Serializer(modelMappers?: {}, isXML?: undefined | false | true): Serializer

Properties

Optional isXML

isXML: undefined | false | true

modelMappers

modelMappers: {}

Type declaration

  • [key: string]: any

Methods

deserialize

  • Deserialize the given object based on its metadata defined in the mapper

    Parameters

    • mapper: Mapper

      The mapper which defines the metadata of the serializable object

    • responseBody: unknown

      A valid Javascript entity to be deserialized

    • objectName: string

      Name of the deserialized object

    • Default value options: SerializerOptions = {}

      Controls behavior of XML parser and builder.

    Returns any

    A valid deserialized Javascript object

serialize

  • Serialize the given object based on its metadata defined in the mapper

    Parameters

    • mapper: Mapper

      The mapper which defines the metadata of the serializable object

    • object: unknown

      A valid Javascript object to be serialized

    • Optional objectName: undefined | string

      Name of the serialized object

    • Default value options: SerializerOptions = {}

      additional options to deserialization

    Returns any

    A valid serialized Javascript object

validateConstraints

  • validateConstraints(mapper: Mapper, value: unknown, objectName: string): void

Generated using TypeDoc