Gathering detailed insights and metrics for @kaivosukeltaja/redux-persist-expo-file-system-storage
Gathering detailed insights and metrics for @kaivosukeltaja/redux-persist-expo-file-system-storage
A highly extensible and configurable storage engine for Redux Persist using Expo FileSystem for persistence in React Native applications.
1.2.0
3
MIT
TypeScript
58.57 kB
Installations
npm install @kaivosukeltaja/redux-persist-expo-file-system-storageDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.11.0
NPM Version
10.8.3
Releases
10
Languages
1
TypeScript
TypeScript (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
3 Stars
32 Commits
1 Forks
1 Watchers
7 Branches
1 Contributors
Updated on Sep 23, 2024
Maintainers
1
Package Meta Information
Latest Version
1.2.0
Package Id
@kaivosukeltaja/redux-persist-expo-file-system-storage@1.2.0
Unpacked Size
58.57 kB
Size
8.73 kB
File Count
7
NPM Version
10.8.3
Node Version
20.11.0
Published on
May 29, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
5
redux-persist-expo-file-system-storage
A highly extensible and configurable storage engine for Redux Persist using Expo FileSystem for persistence in React Native applications.
Check out my article for a quick overview and insights about this package here!
Table of Contents
- Why Choose redux-persist-expo-file-system-storage?
- Features
- Installation
- Usage
- Options
- API
- Contributing
- License
Why Choose redux-persist-expo-file-system-storage?
This package serves as an alternative to the default AsyncStorage, specifically addressing storage size limitations in Android environments (#199). It offers a versatile and efficient solution for managing and persisting state in your React Native applications.
Features
-
Written in TypeScript: Complete TypeScript support for improved type safety and development experience.
-
Extensibility: Designed to be easily extended with options for customizing storage behavior through various callbacks.
-
Configurability: Fine-tune the storage engine with a variety of options, making it adaptable to different project requirements.
-
Debug Mode: Enable the debug mode for detailed logs during development, helping you troubleshoot and understand the library's actions.
-
Custom Logging: Utilize your own logger functions for debug and error messages, allowing seamless integration with your application's logging strategy.
Installation
Choose your preferred package manager and add redux-persist-expo-file-system-storage to your React Native project:
1npm install redux-persist-expo-file-system-storage 2yarn add redux-persist-expo-file-system-storage 3pnpm add redux-persist-expo-file-system-storage 4bun add redux-persist-expo-file-system-storage
After installation, you're ready to integrate the storage engine into your Redux setup for seamless state persistence.
Usage
Here's a simple example demonstrating how to integrate redux-persist-expo-file-system-storage into your application:
1import * as FileSystem from "expo-file-system"; 2import { 3 createExpoFileSystemStorage, 4 type StorageOptions, 5} from "redux-persist-expo-file-system-storage"; 6import type { PersistConfig } from "redux-persist"; 7import { rootReducer, type RootState } from "./store.config"; 8 9// Either without custom options (Default values can be found in the Options section) 10export const expoFileSystemStorage = createExpoFileSystemStorage(); 11 12// or with custom options 13export const expoFileSystemStorage = createExpoFileSystemStorage({ 14 storagePath: `${FileSystem.documentDirectory}customPersistStorageData/`, 15 encoding: FileSystem.EncodingType.BASE64, 16 debug: true, 17 logger: { 18 debug: customDebugFunction, 19 error: customErrorFunction, 20 }, 21 beforeInit: customBeforeInitFunction, 22 afterInit: customAfterInitFunction, 23}); 24 25// Configuration for Redux Persist 26const persistConfig: PersistConfig<RootState> = { 27 key: "root", 28 // Use the ExpoFileSystemStorage as the storage engine 29 storage: expoFileSystemStorage, 30 // ... Add other persist config options if needed 31}; 32 33const persistedReducer = persistReducer(persistConfig, rootReducer); 34 35export const store = configureStore({ 36 reducer: persistedReducer, 37 // ... Add other config options if needed 38});
Options
The storage engine provides various options for customization. Fine-tune your storage engine with the following configuration options:
| Option | Type | Default Value | Description |
| ------------- | ---------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| storagePath | string | FileSystem.documentDirectory + 'persistStorageData/' | The directory path for storing persisted data. It is recommended to provide a custom path for better organization and to avoid potential conflicts with other files in the default | directory. |
| encoding | FileSystem.EncodingType | FileSystem.EncodingType.UTF8 | The encoding type for reading and writing files. Use FileSystem.EncodingType.BASE64 for binary data or if your application deals with non-text data. |
| debug | boolean | false | Enable/disable debug mode. When enabled, detailed logs will be printed during development, aiding in debugging and understanding the library's actions. |
| logger | { debug: Logger, error: Logger } | { debug: console.log, error: console.error } | Custom logger object with debug and error methods. You can provide your own logger functions to tailor the logging behavior according to your application's needs. |
| beforeInit | () => Promise<void> \| void | undefined | Callback function to be executed before initializing the storage. Use this for performing custom actions or setup before the storage engine is ready. |
| afterInit | () => Promise<void> \| void | undefined | Callback function to be executed after initializing the storage. Use this for performing custom actions or setup after the storage engine is ready. |
API
This example demonstrates the direct usage of getItem and setItem methods from ExpoFileSystemStorage. For more details and available methods, please refer to the ExpoFileSystemStorage class.
1import { createExpoFileSystemStorage } from "redux-persist-expo-file-system-storage"; 2 3// Create an instance of ExpoFileSystemStorage 4const expoFileSystemStorage = createExpoFileSystemStorage(); 5 6// Example usage of getItem 7async function exampleGetItem() { 8 try { 9 const key = "exampleKey"; 10 const value = await expoFileSystemStorage.getItem(key); 11 console.log(`Item with key '${key}' has value:`, value); 12 } catch (error) { 13 console.error("Error getting item:", error); 14 } 15} 16 17// Example usage of setItem 18async function exampleSetItem() { 19 try { 20 const key = "exampleKey"; 21 const value = "exampleValue"; 22 await expoFileSystemStorage.setItem(key, value); 23 console.log(`Item with key '${key}' set successfully!`); 24 } catch (error) { 25 console.error("Error setting item:", error); 26 } 27} 28 29exampleGetItem(); 30exampleSetItem();
Contributing
Contributions are welcome! If you encounter issues or have suggestions, please feel free to open an issue or submit a pull request.
This package uses Changesets for version management. For further information on contributing and working with Changesets, refer to the Changesets Documentation: Using Changesets.
License
This project is licensed under the MIT License - see the LICENSE file for details.
No vulnerabilities found.
No security vulnerabilities found.