Interface ObjectMemberMetadata

interface ObjectMemberMetadata {
    deserializer?: ((json, params) => any);
    emitDefaultValue?: boolean;
    isRequired?: boolean;
    key: string;
    name: string;
    options?: MemberOptionsBase;
    serializer?: ((value, params) => any);
    type?: (() => TypeDescriptor);
}

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, params) => any)

Custom deserializer to use.

Type declaration

    • (json, params): any

    • 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, params) => any)

Custom serializer to use.

Type declaration

    • (value, params): any

    • Parameters

      • value: any
      • params: CustomSerializerParams

      Returns any

Optional type

type?: (() => TypeDescriptor)

Type descriptor of the member.

Type declaration

    • (): TypeDescriptor

    • Returns TypeDescriptor

Settings

Member Visibility

Theme

On This Page

deserializeremitDefaultValueisRequiredkeynameoptionsserializertype