SettingsMigrationComponentConstructorParams.contract?

SettingsMigrationComponentConstructorParams › contract?

Type: ApiContract<SettingsMigrationApi<TMigratableSettings>>

The contract this plugin expects of the provider, which wins over the provider's own. Defaults to getSettingsMigrationApiContract, which checks the one method a migration calls.

Kept to SettingsMigrationApi deliberately NARROW. A migration needs one method that has existed since the provider's first contract version, while the same plugin may read other parts of that API through a much newer one. Declaring the wider expectation here would refuse to offer the migration to a user on an older provider — which is precisely the user who still has settings to migrate.