Function migrateCompendium

  • migrateCompendium(
        pack: string | CompendiumCollection<any>,
        options?: {
            fast?: boolean;
            marker?: boolean;
            noHooks?: boolean;
            server?: boolean;
            tracker?: any;
            unlock?: boolean;
        },
    ): Promise<void>

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

    Parameters

    • pack: string | CompendiumCollection<any>

      Compendium (or its ID) to migrate

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

      Additional options

      • Optionalfast?: boolean

        Skip documents marked as migrated for current version.

      • Optionalmarker?: boolean

        Add migration marker to migrated documents.

      • OptionalnoHooks?: boolean

        If true, no migration hooks will be fired.

      • Optionalserver?: boolean

        Call server-side migration. Developers only.

      • Optionaltracker?: any

        Internal only. Tracker instance.

      • Optionalunlock?: boolean

        If false, locked compendium will be ignored.

    Returns Promise<void>

    • Promise that resolves once migration is complete.

    Throws

    • If defined pack is not found.

Settings

Member Visibility