MigrateSettingsParams<TMigratableSettings>

Parameters for SettingsMigrationApi.migrateSettings.

Import:

import type { MigrateSettingsParams } from 'obsidian-dev-utils/obsidian/plugin/settings-migration-api';

Signature:

export interface MigrateSettingsParams<TMigratableSettings extends object>

Properties

Property	Type	Description
proposedSettings	TMigratableSettings	The values the proposing plugin offers. Conventionally every member is optional, so a plugin proposes only what it actually held and a value the provider already owns is never overwritten by a default nobody chose. That convention belongs to the pair, though — this type imposes only the envelope.
sourcePluginId	string	The manifest.id of the plugin making the proposal, so the provider's dialog can say whose settings these are.