@openhps/core
    Preparing search index...

    Interface SerializableMapMemberOptions

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

    Hierarchy (View Summary)

    Index
    constructor? deserializer? emitDefaultValue? isRequired? key? name? preserveNull? serializer? shape? value?
    constructor?: Typelike

    Sets the constructor of the property. Optional with ReflectDecorators.

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

    Custom deserializer for member

    emitDefaultValue?: boolean

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

    isRequired?: boolean

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

    key?: { numberType?: NumberType }

    Type Declaration

    • OptionalnumberType?: NumberType

      Experimental number type

    name?: string

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

    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.

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

    Custom serialized for member

    shape?: MapShape

    How the map should be serialized. Default is ARRAY.

    value?: { numberType?: NumberType }

    Type Declaration

    • OptionalnumberType?: NumberType

      Experimental number type

    Settings
    Member Visibility

    On This Page
    Properties