Function migrateCompendiums

  • migrateCompendiums(
        packs?: null | (string | WorldCollection<any, any>)[],
        options?: {
            dialog?: object;
            fast?: boolean;
            noHooks?: boolean;
            state?: MigrationState;
            unlock?: boolean;
        },
    ): 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?: object;
          fast?: boolean;
          noHooks?: 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.

      • Optionalstate?: MigrationState

        Migration state tracker

      • Optionalunlock?: 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