Generic Document Type

Hierarchy

  • PartiallyConstructible
    • Type

Constructors

  • Parameters

    • Optional source: {
          commonType?: null | CommonFieldType;
          fullName?: string;
          listIndex?: null | number;
          name?: string;
          normalizedName?: string;
      }
      • Optional commonType?: null | CommonFieldType

        Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

      • Optional fullName?: string

        Unique global field type name prefixed with the document types of all containing documents

      • Optional listIndex?: null | number

        A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field

      • Optional name?: string

        Local field type name scoped to the containing document type

      • Optional normalizedName?: string

        Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.

    Returns Field.Type

Properties

commonType: null | CommonFieldType

Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

fullName: string

Unique global field type name prefixed with the document types of all containing documents

listIndex: null | number

A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field

name: string

Local field type name scoped to the containing document type

normalizedName: string

Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.