Function migrateModules

  • migrateModules(
        options?: {
            dialog?: object;
            fast?: boolean;
            server?: boolean;
            state?: MigrationState;
            unlock?: boolean;
        },
    ): Promise<void>

  • Migrate module compendia.

    Convenience wrapper for migrateCompendiums.

    Parameters

    • Optionaloptions: {
          dialog?: object;
          fast?: boolean;
          server?: boolean;
          state?: MigrationState;
          unlock?: boolean;
      } = {}

      Additional options

      • Optionaldialog?: object

        Dialog options. Falsy disables the dialog.

      • Optionalfast?: boolean

        Skip documents marked as migrated for current version.

      • Optionalserver?: boolean

        Call server-side migration. Developers only.

      • Optionalstate?: MigrationState

        Internal only. State tracker instance.

      • Optionalunlock?: boolean

        Unlock compendiums

    Returns Promise<void>

    See

    migrateCompendiums

Settings

Member Visibility