Interface SerializableMapMemberOptions

interface SerializableMapMemberOptions {
    constructor?: Typelike;
    deserializer?: ((json, params) => any);
    emitDefaultValue?: boolean;
    isRequired?: boolean;
    key?: {
        numberType?: NumberType;
    };
    name?: string;
    preserveNull?: boolean;
    serializer?: ((value, params) => any);
    shape?: MapShape;
    value?: {
        numberType?: NumberType;
    };
}

Hierarchy (view full)

Properties

constructor? deserializer? emitDefaultValue? isRequired? key? name? preserveNull? serializer? shape? value?

Properties

Optional constructor

constructor?: Typelike

Sets the constructor of the property. Optional with ReflectDecorators.

Optional deserializer

deserializer?: ((json, params) => any)

Custom deserializer for member

Type declaration

Optional emitDefaultValue

emitDefaultValue?: boolean

When set, a default value is emitted if the property is uninitialized/undefined.

Optional isRequired

isRequired?: boolean

When set, indicates that the member must be present when deserializing.

Optional key

key?: {
    numberType?: NumberType;
}

Type declaration

  • Optional numberType?: NumberType

    Experimental number type

Optional name

name?: string

When set, the key on the JSON that should be used instead of the class property name.

Optional preserveNull

preserveNull?: boolean

Whether to preserve null in the JSON output. When false it will not emit nor store the property if its value is null. Default: false.

Optional serializer

serializer?: ((value, params) => any)

Custom serialized for member

Type declaration

    • (value, params): any

    • Custom serialized for member

      Parameters

      Returns any

Optional shape

shape?: MapShape

How the map should be serialized. Default is ARRAY.

Optional value

value?: {
    numberType?: NumberType;
}

Type declaration

  • Optional numberType?: NumberType

    Experimental number type

Settings

Member Visibility

Theme

On This Page