Function migrateCompendium

Parameters

• pack: string | CompendiumCollection<any>

  Compendium (or its ID) to migrate

• Optionaloptions: {
      fast?: boolean;
      marker?: boolean;
      noHooks?: boolean;
      prune?: 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.

  • Optionalprune?: boolean

    Prune excess data

  • Optionalserver?: boolean

    Call server-side migration. Developers only.

  • Optionaltracker?: any

    Internal only. Tracker instance.

  • Optionalunlock?: boolean

    If false, locked compendium will be ignored.