https://github.com/mubashardev/get_storage_pro
https://github.com/mubashardev/get_storage_pro
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mubashardev/get_storage_pro
- Owner: mubashardev
- License: mit
- Created: 2024-03-25T14:06:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-29T04:10:44.000Z (10 months ago)
- Last Synced: 2025-01-22T18:30:04.258Z (4 months ago)
- Language: Dart
- Size: 49.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 💾 Get Storage Pro 💾
[](https://pub.dartlang.org/packages/get_storage_pro)
[](https://github.com/MicroProgramer/get_storage_pro)
[](https://github.com/MicroProgramer/get_storage_pro)
A Flutter package dependent on [`get_storage`](https://pub.dev/packages/get_storage) for extending functionalities of [`get_storage`](https://pub.dev/packages/get_storage).
## Overview
`get_storage_pro` simplifies the process of storing and retrieving objects directly to/from storage, eliminating the need to manually convert objects to maps and vice versa. It provides functionalities to store objects, lists of objects, and fetch single or multiple objects from storage.
**Important**: Before using `GetStoragePro`, ensure you call `GetStoragePro.init()` to initialize the package. Unlike `get_storage`, there's no need to call `GetStorage.init()` separately.
### Example:
```dart
import 'package:get_storage_pro/get_storage_pro.dart';
import 'main.reflectable.dart';
void main() async {
initializeReflectable();
WidgetsFlutterBinding.ensureInitialized();
// Initialize GetStoragePro (call this before using any GetStoragePro functionality)
await GetStoragePro.init();
// Your code here...
runApp(const MyApp());
}
```
---
# 🔨 Usage
1. Define your model classes annotating with `@gsp` and extending `CommonDataClass` and implementing required functions. Ensure your model class includes an `id` attribute of type `String`. And implement `fromMap` and `toMap` methods.
```dart
import 'package:get_storage_pro/src/common_data_class.dart';
@gsp
class YourModel extends CommonDataClass {
final String id;
final String name;
YourModel({required this.id, required this.name});
//Must have a factory named constructor fromMap
factory YourModel.fromMap(Map map) {
return YourModel(
id: map['id'] as String,
name: map['name'] as String,
);
}
@override
Map toMap() {
return {'id': id, 'name': name};
}
}
```
2. Now run the command in your terminal of project root: `dart pub run build_runner build`
This will create a new file `main.reflectable.dart` in root folder of your project, don't change anything in that file.
3. Now just call `initializeReflectable();` in `main.dart` main function.
## Use `GetStoragePro` to store and fetch data:
```dart
import 'package:get_storage_pro/get_storage_pro.dart';
import 'main.reflectable.dart';
void main() {
initializeReflectable();
// Save a single object
YourModel model = YourModel(id: '1', name: 'John');
GetStoragePro.saveObject(model);
// Save a list of objects
List models = [
YourModel(id: '2', name: 'Alice'),
YourModel(id: '3', name: 'Bob'),
];
GetStoragePro.saveObjectsList(models);
// Get a single object by ID
YourModel? retrievedModel = GetStoragePro.getObjectById('1');
print(retrievedModel?.name); // Output: John
// Get all saved objects
List allModels = GetStoragePro.getAllObjects();
print(allModels.length); // Output: 3 (including the previously saved objects)
// Remove an object by ID
GetStoragePro.deleteById('1');
// Remove all objects of type YourModel
GetStoragePro.deleteAllObjects();
// Listen for changes to a specific object by ID
GetStoragePro.listenForObjectChanges(id: '1', onData: (model) {
print('Updated model: ${model?.name}');
});
// Listen for changes to all objects of type YourModel
GetStoragePro.listenAllObjects(onData: (models) {
print('All models: $models');
});
}
```
# 📢 Functionality
## `GetStoragePro`
* `T? getObjectById>(String id)`: Retrieves an object of type T by its ID from storage. Returns null if no object with the specified ID is found.
* `void saveObjectsList>(List> data)`: Saves a list of objects of type T to storage.
* `void saveObject>(CommonDataClass data)`: Saves a single object of type T to storage.
* `List getAllObjects>()`: Retrieves all saved objects of type T from storage.
* `void deleteById>(String id)`: Removes the object with the specified ID of type T from storage.
* `void deleteAllObjects>()`: Removes all objects of type T from storage.
* `void listenForObjectChanges>({required String id, required Function(T?) onData})`: Listens for changes to a specific object of type T by its ID. Calls onData with the updated object whenever changes occur.
* `void listenAllObjects>({required Function(List) onData})`: Listens for changes to all objects of type T. Calls onData with the updated list of objects whenever changes occur.
## 📓 Note
Ensure your model classes must extend `CommonDataClass` and implement the required functions.
This package relies on the [`get_storage`](https://pub.dev/packages/get_storage) package for storage functionality.
- This is a basic implementation. In the future, more features will be added and existing ones will be improved.
# 👋 Get Involved
If this package is useful to you please 👍 on [pub.dev](https://pub.dev/packages/get_storage_pro) and ⭐ on [GitHub](https://github.com/MicroProgramer/get_storage_pro). If you have any Issues, recommendations or pull requests I'd love to see them!