Class GenericDocumentType

constructor

• new GenericDocumentType(source?): GenericDocumentType

• Parameters

  • Optional source: DeepPartial<GenericDocumentType>

  Returns GenericDocumentType

Readonly fullName

Readonly listIndex

Readonly name

Readonly normalizedName

serialize

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

• Parameters

  • Optional config: ToJsonConfiguration

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

  • Optional Readonly fullName?: string

    Unique global document 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 document type name.

  • Optional Readonly normalizedName?: string

    Normalized global document type name. Common document types appearing as child documents in different places will often have the same normalized type name.