Function migrateCompendiums

  • migrateCompendiums(packs?, options?): Promise<void>

  • Migrate compendiums.

    Parameters

    • Optionalpacks: null | (string | WorldCollection<any, any>)[] = null

      Array of pack IDs or packs to migrate. If null, all packs will be migrated.

    • Optionaloptions: {
          dialog: undefined | object;
          fast: undefined | boolean;
          noHooks: undefined | boolean;
          state: undefined | MigrationState;
          unlock: undefined | boolean;
      } = {}

      Additional options to pass along.

      • dialog: undefined | object

        Display migration dialog. Falsy disables.

      • fast: undefined | boolean

        Skip documents marked as migrated for current version.

      • noHooks: undefined | boolean

        If true, no migration hooks will be fired.

      • state: undefined | MigrationState

        Migration state tracker

      • unlock: undefined | boolean

        If false, locked compendiums are ignored.

    Returns Promise<void>

    • Promise that resolves once all migrations are complete.

    See

    migrateCompendium

    Throws

    • If defined pack is not found.

Settings

Member Visibility