Skip to content

SettingsMigrationApi.migrateSettings

SettingsMigrationApi › migrateSettings

Type: (params: MigrateSettingsParams<TMigratableSettings>) => Promise<MigrateSettingsResult>

Offers the user a set of settings values another plugin proposes, and applies what they approve.

Resolves only once the dialog is closed, so the caller learns whether the migration actually happened and can retire — or withhold — its own pending values on that answer.