migrateFromLegacyPrefsIfNeeded static method

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

Migrates data from legacy SharedPreferences to SharedPreferencesAsync.

This method should be called once during app initialization if migrating from a previous version that used the legacy SharedPreferences API.

migrationKey is used to mark that migration has been completed.

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',
  );
}