migrateFromLegacyPrefsIfNeeded static method

Future<void> migrateFromLegacyPrefsIfNeeded({
  1. String migrationKey = 'prf_migrated',
})

Migrates data from legacy SharedPreferences to SharedPreferencesAsync.

This method ensures that data stored in the older SharedPreferences system is properly transferred to the new SharedPreferencesAsync system. It only performs the migration once, tracking completion with the provided migration key.

Parameters:

  • migrationKey: Key used to track whether migration has already occurred. Defaults to 'prf_migrated'.

Implementation

static Future<void> migrateFromLegacyPrefsIfNeeded({
  String migrationKey = 'prf_migrated',
}) async {
  final legacy = await SharedPreferences.getInstance();
  const sharedPreferencesOptions = SharedPreferencesOptions(); // defaults

  await migrateLegacySharedPreferencesToSharedPreferencesAsyncIfNecessary(
    legacySharedPreferencesInstance: legacy,
    sharedPreferencesAsyncOptions: sharedPreferencesOptions,
    migrationCompletedKey: 'migrationCompleted',
  );
}