@illandril/foundryvtt-types/src/foundry/abstract/Document.d.ts

Type definitions for the Foundry VTT client, used by Illandril's modules

declare global {
  namespace foundry {
    namespace abstract {
      type DocumentFields = {
        _id: string;
      };

      class Document extends foundry.abstract.DataModel {
        get id(): string;
        get system(): unknown;

        delete(context?: DocumentModificationContext): Promise<Document>;
        static deleteDocuments(ids: string[], context?: DocumentModificationContext): Promise<Document[]>;

        getFlag(scope: string, key: string): unknown;
        setFlag(scope: string, key: string, value: unknown): void;
        unsetFlag(scope: string, key: string): void;

        updateEmbeddedDocuments(
          embeddedName: string,
          updates?: unknown[],
          context?: unknown,
        ): Promise<foundry.abstract.Document[]>;

        testUserPermission(
          user: foundry.documents.BaseUser,
          permission: keyof typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS | number,
          options?: { exact: boolean },
        ): boolean;
      }
    }
  }
}

export type {};