getSettingsMigrationApiContract<TMigratableSettings>
The contract of SettingsMigrationApi, which both ends of a handover compile against: the provider publishes it, and SettingsMigrationComponent checks the provider against it unless given another.
The proposed settings are checked to be an object and no further, because their shape is the pair’s own business (see the file header).
Import:
import { getSettingsMigrationApiContract } from '@mnaoumov/obsidian-lib/plugin/settings-migration-api';Signature:
function getSettingsMigrationApiContract(): TypedApiContract<SettingsMigrationApi<TMigratableSettings>>Returns: TypedApiContract<SettingsMigrationApi<TMigratableSettings>> — The contract.
Links to this page: