Interface SerializableMemberOptions

Hierarchy-Diagram

UML class diagram of SerializableMemberOptions
Legend
icon for an interface in the UML class diagram interface

Hierarchy

Properties

constructor? deserializer? emitDefaultValue? index? isRequired? name? numberType? preserveNull? primaryKey? serializer? unique?

Properties

Optional constructor

constructor?: Typelike

Sets the constructor of the property. Optional with ReflectDecorators.

Optional deserializer

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

Type declaration

Optional emitDefaultValue

emitDefaultValue?: boolean

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

Optional index

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.

Optional isRequired

isRequired?: boolean

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

Optional name

name?: string

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

Optional numberType

numberType?: NumberType

Experimental number type

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 primaryKey

primaryKey?: boolean

Identify this attribute as a primary key

Optional serializer

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

Type declaration

Optional unique

unique?: boolean

Identify this attribute as unique

Settings

Member Visibility

Theme