Class FieldType

constructor

• new FieldType(source?: DeepPartial<FieldType>): FieldType

  Parameters

  • Optionalsource: DeepPartial<FieldType>

  Returns FieldType

ReadonlycommonType

ReadonlyfullName

ReadonlylistIndex

Readonlyname

ReadonlynormalizedName

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      commonType?: CommonFieldType | null;
      fullName?: string;
      listIndex?: number | null;
      name?: string;
      normalizedName?: string;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      commonType?: CommonFieldType | null;
      fullName?: string;
      listIndex?: number | null;
      name?: string;
      normalizedName?: string;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
  }

  • Optional ReadonlycommonType?: CommonFieldType | null

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

  • Optional ReadonlyfullName?: string

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

  • Optional ReadonlylistIndex?: number | null

    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 Readonlyname?: string

    Local field type name scoped to the containing document type.

  • Optional ReadonlynormalizedName?: 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.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }