Function migrateCompendiums

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?: object;
      fast?: boolean;
      noHooks?: boolean;
      prune?: boolean;
      server?: boolean;
      state?: MigrationState;
      unlock?: boolean;
  } = {}

  Additional options to pass along.

  • Optionaldialog?: object

    Display migration dialog. Falsy disables.

  • Optionalfast?: boolean

    Skip documents marked as migrated for current version.

  • OptionalnoHooks?: boolean

    If true, no migration hooks will be fired.

  • Optionalprune?: boolean

    Prune excess data

  • Optionalserver?: boolean

    Perform server-side migration

  • Optionalstate?: MigrationState

    Migration state tracker

  • Optionalunlock?: boolean

    If false, locked compendiums are ignored.