jt_preferences

Description:

jt preferences

JtPreferences #

Supported data types are int, double, bool, String and Writable object.
Usage #
To use this plugin, add jt_preferences as
a dependency in your pubspec.yaml file
.
Examples #
Here are small examples that show you how to use the package.
Initialize #
void main(List<String> args) async {
//for example (data/data/com.example.application/) without absolute path
await JtPreferences.initialize("path/path", encryptionKey: '16 length encryption key');
//Data will be encrypted if encryptionKey is not null
}
copied to clipboard
Write data
// Obtain shared preferences.
final preferences = await JtPreferences.getInstance();

// Save an integer value to 'counter' key.
await preferences.setInt('counter', 10);
// Save an boolean value to 'repeat' key.
await preferences.setBool('repeat', true);
// Save an double value to 'decimal' key.
await preferences.setDouble('decimal', 1.5);
// Save an String value to 'action' key.
await preferences.setString('action', 'Start');

//Save writable object
await preferences.saveObject(User(name: 'user', age: 12));

copied to clipboard
Example User Writable object #
class User extends Writable {
final String name;
final int age;

@override
factory User.fromJson(Map<String, dynamic> map) {
return User(name: map['name'], age: map['age']);
}

@override
OnConflictStrategy? get onConflictStrategy => OnConflictStrategy.update;

@override
Map<String, dynamic> toJson() {
return {
"name": name,
"age": age,
};
}

User({
required this.name,
required this.age,
});

@override
String key => name;
}

copied to clipboard
Read data
// Try reading data from the 'counter' key. If it doesn't exist, returns null.
final int? counter = preferences.getInt('counter');
// Try reading data from the 'repeat' key. If it doesn't exist, returns null.
final bool? repeat = preferences.getBool('repeat');
// Try reading data from the 'decimal' key. If it doesn't exist, returns null.
final double? decimal = preferences.getDouble('decimal');
// Try reading data from the 'action' key. If it doesn't exist, returns null.
final String? action = preferences.getString('action');

final List<String>? keys = preferences.getKeys();

final object = preferences.getObject('user', (map) => User.fromJson(map));
print(object?.name);
print(object?.age);

copied to clipboard
Listen changes #
//listen all changes
preferences.listen().listen((event) {
print("key $event updated");
});

//listen only specific key
preferences.stream(key: 'counter').listen((event) {
print("key $event updated");
});

copied to clipboard
Remove an entry
// Remove data for the 'counter' key.
final success = await preferences.remove('counter');
copied to clipboard