Function findInCompendia

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

findInCompendia(searchTerm, options?): false | {
index: object;
pack: CompendiumCollection<any>;
}
Parameters
- searchTerm: string
  The name of the Document being searched for
- Optionaloptions: {
      disabled: undefined | boolean;
      docType: undefined | string;
      packs: undefined | string[];
      type:
          | undefined
          | "Actor"
          | "Item"
          | "JournalEntry"
          | "Macro"
          | "Playlist"
          | "RollTable"
          | "Scene";
  } = {}
  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"
        | "Item"
        | "JournalEntry"
        | "Macro"
        | "Playlist"
        | "RollTable"
        | "Scene"
    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
- Defined in module/utils/lib.mjs:715

Function findInCompendia

Parameters

disabled: undefined | boolean

docType: undefined | string

packs: undefined | string[]

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

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

Settings

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

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