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

TypeScript type definitions for Foundry VTT

import type { Identity } from "#utils";
import type Document from "#common/abstract/document.d.mts";

/**
 * The singleton collection of Item documents which exist within the active World.
 * This Collection is accessible within the Game object as game.items.
 *
 * @see {@linkcode Item} The Item document
 * @see {@linkcode ItemDirectory} The ItemDirectory sidebar directory
 */
declare class Items extends foundry.documents.abstract.WorldCollection<"Item", "Items"> {
  static documentName: "Item";
}

declare namespace Items {
  /** @deprecated There should only be a single implementation of this class in use at one time, use {@linkcode Implementation} instead */
  type Any = Internal.Any;

  /** @deprecated There should only be a single implementation of this class in use at one time, use {@linkcode ImplementationClass} instead */
  type AnyConstructor = Internal.AnyConstructor;

  namespace Internal {
    interface Any extends AnyItems {}
    interface AnyConstructor extends Identity<typeof AnyItems> {}
  }

  interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Item"> {}
  interface Implementation extends Document.Internal.ConfiguredCollection<"Item"> {}

  /**
   * @deprecated Replaced by {@linkcode Items.ImplementationClass}.
   */
  type ConfiguredClass = ImplementationClass;

  /**
   * @deprecated Replaced by {@linkcode Items.Implementation}.
   */
  type Configured = Implementation;
}

declare abstract class AnyItems extends Items {
  constructor(...args: never);
}

export default Items;