Skip to content

SettingsMigrationComponentConstructorParams.retireProposedSettings

SettingsMigrationComponentConstructorParams › retireProposedSettings

Type: () => Promisable<void>

Records that the pending values have been handed over, so the offer is not made again.

Called ONLY when the user actually applied the migration.

Remarks:

An implementation must PERSIST the retirement — pluginSettingsComponent.editAndSave(…), not setProperty(…). The latter only edits the in-memory state, so the retirement is forgotten on the next reload and the migration is offered again forever.