Heroic Lands

Function getDocumentFromPacks

  • getDocumentFromPacks(
        docName: string,
        packNames: string[],
        options?: { docType?: string; documentName?: string; keepId?: boolean },
    ): Promise<any | undefined>

  • Retrieves a document from specified packs based on name and optional type.

    Parameters

    • docName: string

      The name of the document to find.

    • packNames: string[]

      The compendium pack names to search.

    • options: { docType?: string; documentName?: string; keepId?: boolean } = ...

      Lookup options.

      • OptionaldocType?: string

        Optional document subtype to filter by.

      • OptionaldocumentName?: string

        The document type the pack must hold.

      • OptionalkeepId?: boolean

        Whether to preserve the source _id (otherwise a new ID is assigned).

    Returns Promise<any | undefined>

    The matching document data prepared for import, or undefined if not found.

Settings

Member Visibility