• Searches through compendia quickly using the system generated index caches. Exact matches excluding punctuation and case are prioritized before searching word order permutations.

    Parameters

    • searchTerm: string

      The name of the Document being searched for

    • Optional options: {
          disabled: undefined | boolean;
          docType: undefined | string;
          packs: undefined | string[];
          type: undefined | "Actor" | "Scene" | "Item" | "JournalEntry" | "Macro" | "Playlist" | "RollTable";
      } = {}

      Provides a filter to limit search to specific packs or Document types

      • disabled: undefined | boolean

        Include packs disabled for compendium browser.

      • docType: undefined | string

        Document type, such as "loot" or "npc"

      • packs: undefined | string[]

        An array of packs to search in

      • type: undefined | "Actor" | "Scene" | "Item" | "JournalEntry" | "Macro" | "Playlist" | "RollTable"

        A Document type to limit which packs are searched in

    Returns false | {
        index: object;
        pack: CompendiumCollection<any>;
    }

    The index and pack containing it or undefined if no match is found

Generated using TypeDoc