Interface ObjectMetadata

interface ObjectMetadata {
    beforeSerializationMethodName?: string;
    classType: Function;
    dataMembers: Map<string, ObjectMemberMetadata>;
    initializerCallback?: ((sourceObject, rawSourceObject) => Object);
    isExplicitlyMarked: boolean;
    isHandledWithoutAnnotation: boolean;
    knownTypes: Set<Serializable<any>>;
    knownTypesDeferred: (() => TypeDescriptor)[];
    name?: string;
    onDeserializedMethodName?: string;
    options?: SerializableObjectOptions<any>;
    typeHintEmitter?: TypeHintEmitter;
    typeResolver?: TypeResolver;
    processDeferredKnownTypes(): void;
}

Hierarchy (view full)

Properties

beforeSerializationMethodName? classType dataMembers initializerCallback? isExplicitlyMarked isHandledWithoutAnnotation knownTypes knownTypesDeferred name? onDeserializedMethodName? options? typeHintEmitter? typeResolver?

Methods

processDeferredKnownTypes

Properties

Optional beforeSerializationMethodName

beforeSerializationMethodName?: string

classType

classType: Function

Gets or sets the constructor function for the jsonObject.

dataMembers

dataMembers: Map<string, ObjectMemberMetadata>

Optional initializerCallback

initializerCallback?: ((sourceObject, rawSourceObject) => Object)

Type declaration

    • (sourceObject, rawSourceObject): Object

    • Parameters

      • sourceObject: Object
      • rawSourceObject: Object

      Returns Object

isExplicitlyMarked

isExplicitlyMarked: boolean

Indicates whether this class was explicitly annotated with

Json Object

or implicitly by

Json Member

isHandledWithoutAnnotation

isHandledWithoutAnnotation: boolean

Indicates whether this type is handled without annotation. This is usually used for the builtin types (except for Maps, Sets, and normal Arrays).

knownTypes

knownTypes: Set<Serializable<any>>

Set of known types used for polymorphic deserialization

knownTypesDeferred

knownTypesDeferred: (() => TypeDescriptor)[]

Known types to be evaluated when (de)serialization occurs

Type declaration

    • (): TypeDescriptor

    • Returns TypeDescriptor

Optional name

name?: string

Name used to encode polymorphic type

Optional onDeserializedMethodName

onDeserializedMethodName?: string

Optional options

options?: SerializableObjectOptions<any>

Optional typeHintEmitter

typeHintEmitter?: TypeHintEmitter

If present override the global function

Optional typeResolver

typeResolver?: TypeResolver

If present override the global function

Methods

processDeferredKnownTypes

Settings

Member Visibility

Theme

On This Page

beforeSerializationMethodNameclassTypedataMembersinitializerCallbackisExplicitlyMarkedisHandledWithoutAnnotationknownTypesknownTypesDeferrednameonDeserializedMethodNameoptionstypeHintEmittertypeResolverprocessDeferredKnownTypes