Class Deserializer

Hierarchy-Diagram

UML class diagram of Deserializer
Legend
icon for a class in the UML class diagram class

Hierarchy

  • unknown
    • Deserializer

Constructors

constructor

Properties

createKnownTypesMap deserializationStrategy errorHandler getErrorHandler getTypeResolver instantiateType mergeKnownTypes nameResolver? options? retrievePreserveNull setDeserializationStrategy setErrorHandler setNameResolver setTypeResolver

Methods

convertAsArray convertAsMap convertAsObject convertAsSet convertSingleValue identityDeserializer isExpectedMapShape makeTypeErrorMessage typeResolver

Constructors

constructor

Properties

createKnownTypesMap

createKnownTypesMap: ((knowTypes) => Map<string, Serializable<any>>)

Type declaration

Protected deserializationStrategy

deserializationStrategy: Map<Serializable<any>, DeserializerFn<any, TypeDescriptor, any>>

Protected errorHandler

errorHandler: ((error) => void) = ...

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

getErrorHandler

getErrorHandler: (() => ((error) => void))

Type declaration

    • (): ((error) => void)

    • Returns ((error) => void)

        • (error): void

        • Parameters

          • error: Error

          Returns void

getTypeResolver

getTypeResolver: (() => TypeResolver)

Type declaration

    • (): TypeResolver

    • Returns TypeResolver

instantiateType

instantiateType: ((ctor) => any)

Type declaration

    • (ctor): any

    • Parameters

      • ctor: any

      Returns any

mergeKnownTypes

mergeKnownTypes: ((...knownTypeMaps) => Map<string, Serializable<any>>)

Type declaration

Protected Optional nameResolver

nameResolver?: ((ctor) => string)

Type declaration

    • (ctor): string

    • Parameters

      Returns string

Protected Optional options

options?: OptionsBase

retrievePreserveNull

retrievePreserveNull: ((memberOptions?) => boolean)

Type declaration

setDeserializationStrategy

setDeserializationStrategy: ((type, deserializer) => void)

Type declaration

setErrorHandler

setErrorHandler: ((errorHandlerCallback) => void)

Type declaration

    • (errorHandlerCallback): void

    • Parameters

      • errorHandlerCallback: ((error) => void)
          • (error): void

          • Parameters

            • error: Error

            Returns void

      Returns void

setNameResolver

setNameResolver: ((nameResolverCallback) => void)

Type declaration

    • (nameResolverCallback): void

    • Parameters

      • nameResolverCallback: ((ctor) => string)
          • (ctor): string

          • Parameters

            Returns string

      Returns void

setTypeResolver

setTypeResolver: ((typeResolverCallback) => void)

Type declaration

    • (typeResolverCallback): void

    • Parameters

      • typeResolverCallback: TypeResolver

      Returns void

Methods

convertAsArray

  • convertAsArray(sourceObject, typeDescriptor, knownTypes, memberName, deserializer, memberOptions?, serializableOptions?): any[]

  • Parameters

    Returns any[]

convertAsMap

  • convertAsMap(sourceObject, typeDescriptor, knownTypes, memberName, deserializer, memberOptions?, serializableOptions?): Map<any, any>

  • Parameters

    Returns Map<any, any>

convertAsObject

convertAsSet

  • convertAsSet(sourceObject, typeDescriptor, knownTypes, memberName, deserializer, memberOptions?, serializableOptions?): Set<any>

  • Parameters

    Returns Set<any>

convertSingleValue

  • convertSingleValue(sourceObject, typeDescriptor, knownTypes, memberName?, memberOptions?, serializerOptions?): any

  • Parameters

    • sourceObject: any
    • typeDescriptor: TypeDescriptor
    • knownTypes: Map<string, Serializable<any>>
    • Optional memberName: string
    • Optional memberOptions: ObjectMemberMetadata
    • Optional serializerOptions: any

    Returns any

Protected identityDeserializer

  • identityDeserializer<T>(sourceObject, _, knownTypes, ...args): T

  • Type Parameters

    • T

    Parameters

    • sourceObject: T
    • _: TypeDescriptor
    • knownTypes: Map<string, Serializable<any>>
    • Rest ...args: any[]

    Returns T

Protected isExpectedMapShape

  • isExpectedMapShape(source, expectedShape): boolean

  • Parameters

    • source: any
    • expectedShape: any

    Returns boolean

Protected makeTypeErrorMessage

Protected typeResolver

Settings

Member Visibility

Theme

On This Page

constructorcreateKnownTypesMapdeserializationStrategyerrorHandlergetErrorHandlergetTypeResolverinstantiateTypemergeKnownTypesnameResolveroptionsretrievePreserveNullsetDeserializationStrategysetErrorHandlersetNameResolversetTypeResolverconvertAsArrayconvertAsMapconvertAsObjectconvertAsSetconvertSingleValueidentityDeserializerisExpectedMapShapemakeTypeErrorMessagetypeResolver