Interface ObjectMemberMetadata

Hierarchy-Diagram

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

Hierarchy

  • JsonMemberMetadata
    • ObjectMemberMetadata

Properties

deserializer? emitDefaultValue? isRequired? key name options? serializer? type?

Properties

Optional deserializer

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

Type declaration

    • (json: any, params: CustomDeserializerParams): any

    • Custom deserializer to use.

      Parameters

      • json: any
      • params: CustomDeserializerParams

      Returns any

Optional emitDefaultValue

emitDefaultValue?: boolean

If set, a default value will be emitted for uninitialized members.

Optional isRequired

isRequired?: boolean

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

key

key: string

Property or field key of the json member.

name

name: string

Member name as it appears in the serialized JSON.

Optional options

options?: MemberOptionsBase

Optional serializer

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

Type declaration

    • (value: any, params: CustomSerializerParams): any

    • Custom serializer to use.

      Parameters

      • value: any
      • params: CustomSerializerParams

      Returns any

Optional type

type?: (() => TypeDescriptor)

Type declaration

    • (): TypeDescriptor

    • Type descriptor of the member.

      Returns TypeDescriptor

Settings

Member Visibility

Theme