Class FieldType

constructor

• new FieldType(source?): FieldType

• Parameters

  • Optional source: DeepPartial<FieldType>

  Returns FieldType

Readonly commonType

Readonly fullName

Readonly listIndex

Readonly name

Readonly normalizedName

serialize

• serialize(config?): {
      commonType?: null | CommonFieldType;
      fullName?: string;
      listIndex?: null | number;
      name?: string;
      normalizedName?: string;
      serialize?: any;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      commonType?: null | CommonFieldType;
      fullName?: string;
      listIndex?: null | number;
      name?: string;
      normalizedName?: string;
      serialize?: any;
  }

  • Optional Readonly commonType?: null | CommonFieldType

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

  • Optional Readonly fullName?: string

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

  • Optional Readonly 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 Readonly name?: string

    Local field type name scoped to the containing document type.

  • Optional Readonly 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.