SettingsMigrationComponentConstructorParams.getProposedSettings method

SettingsMigrationComponentConstructorParams › getProposedSettings

Reads the values currently waiting to be handed over.

Called afresh on every edge rather than once, so an implementation simply reads its plugin's settings. Return null when there is nothing pending — after a migration has been applied, or on a vault that never had these settings configured.

Signature:

getProposedSettings(this: void): null | TMigratableSettings

Parameters:

Parameter	Type	Description
this	void

Returns: null | TMigratableSettings — The values to propose, or null when there is nothing to offer.