Function migrateCompendiums

  • Migrate compendiums.

    Parameters

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

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

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

      Additional options to pass along.

      • 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

Theme

Generated using TypeDoc