Class GenericDocumentType

constructor

• new GenericDocumentType(
      source?: DeepPartial<GenericDocumentType>,
  ): GenericDocumentType

  Parameters

  • Optionalsource: DeepPartial<GenericDocumentType>

  Returns GenericDocumentType

ReadonlyfullName

ReadonlylistIndex

Readonlyname

ReadonlynormalizedName

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      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 listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      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 listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
  }

  • Optional ReadonlyfullName?: string

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

  • Optional ReadonlynormalizedName?: string

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

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