fvtt-types/src/foundry/client/documents/collections/compendium-folders.d.mts

TypeScript type definitions for Foundry VTT

/**
 * A Collection of Folder documents within a Compendium pack.
 */
declare class CompendiumFolderCollection extends foundry.documents.abstract.DocumentCollection<"Folder"> {
  constructor(pack: foundry.documents.collections.CompendiumPacks, data: Folder.Source[]);

  pack: foundry.documents.collections.CompendiumPacks;

  get documentName(): "Folder";

  override render(
    force?: boolean,
    options?: foundry.appv1.api.Application.Options | foundry.applications.api.ApplicationV2.RenderOptions,
  ): void;

  /**
   * @privateRemarks Possible this causes depth issues, this is just a small extension in the code with no meaningful transformations
   */
  // updateAll(
  //   transformation:
  //     | DeepPartial<Folder["_source"]>
  //     | ((doc: foundry.abstract.Folder.Stored) => DeepPartial<Folder["_source"]>),
  //   condition?: ((obj: foundry.abstract.Folder.Stored) => boolean) | null,
  //   options?: foundry.abstract.Document.OnUpdateOptions<"Folder">,
  // ): Promise<Folder.Implementation[]>;

  // Note(LukeAbby): The override for `_onModifyContents` becomes unreasonably long and doesn't add any changes and so has been omitted.
}

export default CompendiumFolderCollection;