json_bridge

Description:

json bridge

json_bridge.dart #




A powerful, flexible and easy to use JSON file manager for Dart and flutter app.

Compatibility #
Sdk & Flutter version supported:
✅   SDK: >=2.14.0 <3.0.0
✅   Flutter: >=2.10.0
Platform supported:



Support
Android
iOS
Linux
macOS
Windows




JSONBridge
✔️
✔️
✔️
✔️
✔️




Why should you give a try ? #

👉 It allows you to store and retrieve data from a JSON file.
👉 The JSON file is stored in the application document directory or a dir you provide.
👉 JSONBridge support manipulating nested keys with dot separated.
👉 Use JSONBridge to store user preferences, settings, data, etc.
👉 Use JSONBridge to build the next big and powerfull noSQL database for dart and flutter apps.
👉 Use JSONBridge to store any data in a JSON file within your application.
👉 Use JSONBridge to check if user is using your app for the first time.
👉 Use JSONBridge to track user activity and show him the last seen screen when he restart the app.
Usecases are endless, use your imagination.


Getting Started #
1. Add the dependency #
dependencies:
# Please replace [latest_version] with the latest version.
json_bridge: ^latest_version
copied to clipboard
2. Import the package #
import 'package:json_bridge/json_bridge.dart';
copied to clipboard
3. Initialize the package #

// Omit dir to use your flutter application document directory
JSONBridge jsonBridge = JSONBridge()..init(fileName: 'config', dir: 'test');
copied to clipboard
4. Use the package #
4.1. Write a map into the json file
Note that using the write method will overwrite the entire file.
If you want to add a key/value pair or new json object, consider using the set method
jsonBridge.write({
'name': 'John Doe',
'age': 25,
'address': {
'street': 'Main Street',
'city': 'New York',
'country': 'USA'
}
});
copied to clipboard
The result will be:
{
"name": "John Doe",
"age": 25,
"address": {
"street": "Main Street",
"city": "New York",
"country": "USA"
}
}
copied to clipboard
4.2. Clear all content of the json file and delete it
jsonBridge.clear();
copied to clipboard
4.3. Read the entire content of the json file
Map<String, dynamic> dataFromJsonBridge = jsonBridge.read();
copied to clipboard
Your dataFromJsonBridge variable will contain the entire content of the json file as a Map<String, dynamic>
and should look like in map form:
{
"name": "John Doe",
"age": 25,
"address": {
"street": "Main Street",
"city": "New York",
"country": "USA"
}
}
copied to clipboard
4.4. Add new JSON object
jsonBridge.set('preferences', {
'dark': true,
'receive_notification': false,
'show_update_notification': true,
});
copied to clipboard
Your json file should now contain:
{
"name": "John Doe",
"age": 25,
"address": {
"street": "Main Street",
"city": "New York",
"country": "USA"
},
"preferences": {
"dark": true,
"receive_notification": false,
"show_update_notification": true
}
}
copied to clipboard
4.5. Update a nested key/value pair
Let's say, we want to update the dark mode preference to false
jsonBridge.set('preferences.dark', false);
copied to clipboard
Your json file should now contain:
{
"name": "John Doe",
"age": 25,
"address": {
"street": "Main Street",
"city": "New York",
"country": "USA"
},
"preferences": {
"dark": false,
"receive_notification": false,
"show_update_notification": true
}
}
copied to clipboard
4.6. Get a value
Everywhere you need to provide a key, you can use a dot separated string to access nested keys.
If your key is not found, the method will return null.
If your key contains invalid character, an error will be thrown.
String name = jsonBridge.get('name');
// name = 'John Doe'

int age = jsonBridge.get('age');
// age = 25

String street = jsonBridge.get('address.street');
// street = 'Main Street'

String city = jsonBridge.get('address.city');
// city = 'New York'

String country = jsonBridge.get('address.country');
// country = 'USA'

bool dark = jsonBridge.get('preferences.dark');
// dark = false

bool receiveNotification = jsonBridge.get('preferences.receive_notification');
// receiveNotification = false

bool showUpdateNotification = jsonBridge.get('preferences.show_update_notification');
// showUpdateNotification = true
copied to clipboard
4.7. Delete a key
jsonBridge.delete('preferences.show_update_notification');
copied to clipboard
Your json file should now contain:
{
"name": "John Doe",
"age": 25,
"address": {
"street": "Main Street",
"city": "New York",
"country": "USA"
},
"preferences": {
"dark": false,
"receive_notification": false
}
}
copied to clipboard
4.8. Check if a key exists
bool exists = jsonBridge.exists('preferences.dark');
// exists = true

bool exists = jsonBridge.exists('iKnowThisKeyDoesNotExist');
// exists = false
copied to clipboard
API #
Below, the full list of methods available in JSONBridge.
Once again, everywhere you see a key, you can use dot separated keys to access nested keys.



Method Name
Description




void init({required String fileName, String? dir})
Init the bridge by creating the json file. Should be call before any other method


Map<String, dynamic> read()
Reads the JSON file and returns a Map.


void write(Map<String, dynamic> data)
Write a map into the json file. It override all previous content


void clear()
Delete completly the json file


void set(String key, dynamic value)
Add or update a key


void delete(String key)
Delete a key from the json file


dynamic get(String key)
Get a value from the json file


bool has(String key)
Check if a key exists in the JSON file.



Support #
Please email to dah.kenangnon (at) gmail (dot) com if you have any questions or comments or business support.
Contributing #
Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given. Please see the contribution guidelines and code of conduct for more details.
Fire up now and enjoy! 🚀
Copyright & License #
This project is licensed under the BSD-3-Clause License - see the LICENSE file for details.
Maintained by Justin Dah-kenangnon with ❤️