Function migrateCompendium

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

    Parameters

    • pack: string | CompendiumCollection<any>

      Compendium (or its ID) to migrate

    • Optional options: {
          unlock: undefined | boolean;
      } = {}

      Additional options

      • unlock: undefined | 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

Theme

Generated using TypeDoc