MigrateSettingsResult

The outcome of SettingsMigrationApi.migrateSettings.

Import:

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

Signature:

export interface MigrateSettingsResult

Properties

Property	Type	Description
isApplied	boolean	Whether the user approved the migration. false means they cancelled and nothing was written, so the proposing plugin must NOT record the migration as done — a cancel is not an answer, and the offer has to come back.

---

Links to this page:

• SettingsMigrationApi