@openhps/core
    Preparing search index...

    Interface SerializableMemberOptions

    interface SerializableMemberOptions {
        constructor?: Typelike;
        deserializer?: (json: any, params: CustomDeserializerParams) => any;
        emitDefaultValue?: boolean;
        index?: string | boolean;
        isRequired?: boolean;
        name?: string;
        numberType?: NumberType;
        preserveNull?: boolean;
        primaryKey?: boolean;
        serializer?: (value: any, params: CustomSerializerParams) => any;
        unique?: boolean;
    }

    Hierarchy (View Summary)

    Index
    constructor? deserializer? emitDefaultValue? index? isRequired? name? numberType? preserveNull? primaryKey? serializer? unique?
    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.

    index?: string | boolean

    Create an index on this attribute. Possible values are true/false or a string for specifying this attribute as part of multiple attributes in an index.

    isRequired?: boolean

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

    name?: string

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

    numberType?: NumberType

    Experimental number type

    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.

    primaryKey?: boolean

    Identify this attribute as a primary key

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

    Custom serialized for member

    unique?: boolean

    Identify this attribute as unique

    Settings
    Member Visibility

    On This Page
    Properties