short_term_caching - Dart API docs

TempCache: A Simple, Efficient In-Memory Data Store

Overview

TempCache is a lightweight, in-memory data storage solution built using Hive and Hive Flutter. It's designed for short-term caching of data, providing a convenient way to store and retrieve information within your Flutter application.

Key Features

Simple API: Easy-to-use methods for saving, reading, and removing data.
Generic Data Storage: Accommodates various data types.
Efficient Storage: Leverages Hive's optimized storage mechanism.
Clear All Functionality: Quickly clears all stored data.

How to Use

Initialization:
```
await TempCache().init();
```

Saving Data:

TempCache().saveData('myKey', 'myValue');
TempCache().saveData('myNumber', 42);

Reading Data:

String? myValue = TempCache().readData('myKey');
int? myNumber = TempCache().readData('myNumber');

Removing Data:
```
TempCache().removeData('myKey');
```
Clearing All Data:
```
TempCache().clearAll();
```

Important Considerations

Data Persistence: TempCache is primarily designed for in-memory storage. While Hive can persist data to disk, TempCache's primary use case is for transient data that doesn't need to be preserved across app restarts.
Data Security: If you're storing sensitive information, consider additional security measures. Hive offers encryption options, but it's important to evaluate your specific security requirements.

Additional Tips

Key Selection: Choose meaningful keys to easily identify and retrieve data.
Data Validation: Implement data validation to ensure data integrity.
Error Handling: Consider error handling for operations like saving, reading, and removing data.

By following these guidelines and leveraging TempCache's simplicity, you can effectively manage short-term data storage in your Flutter applications.

Libraries

short_term_caching package