• Apply migration rules to all Documents within a single Compendium pack

    Parameters

    • pack: string | CompendiumCollection<any>

      Compendium (or its ID) to migrate

    • Optionaloptions: {
          fast: undefined | boolean;
          marker: undefined | boolean;
          noHooks: undefined | boolean;
          server: undefined | boolean;
          tracker: any;
          unlock: undefined | boolean;
      } = {}

      Additional options

      • fast: undefined | boolean

        Skip documents marked as migrated for current version.

      • marker: undefined | boolean

        Add migration marker to migrated documents.

      • noHooks: undefined | boolean

        If true, no migration hooks will be fired.

      • server: undefined | boolean

        Call server-side migration. Developers only.

      • tracker: any

        Internal only. Tracker instance.

      • unlock: undefined | boolean

        If false, locked compendium will be ignored.

    Returns Promise<void>

    • Promise that resolves once migration is complete.
    • If defined pack is not found.