@@ -10,7 +10,9 @@ A storage wrapper that adds expiration functionality to `localStorage` or any ot
1010npm install expiring-storage
1111```
1212
13- ## Usage
13+ ## Examples
14+
15+ ### Basic Usage
1416
1517``` javascript
1618import { wrapStorage } from " expirix" ;
@@ -25,6 +27,31 @@ storage.setItem("key", "value");
2527const value = storage .getItem (" key" );
2628```
2729
30+ ### Creating a reusable storage module
31+
32+ ``` javascript
33+ // app-storage.js
34+ import { wrapStorage } from " expirix" ;
35+
36+ const wrappedLocalStorage = wrapStorage (localStorage, {
37+ expiresInSeconds: 3600 ,
38+ });
39+
40+ export default wrappedLocalStorage ;
41+ ```
42+
43+ ``` javascript
44+ // Using in your app
45+ import storage from " ./app-storage.js" ;
46+
47+ // Store user preferences that expire in 1 hour
48+ storage .setItem (" theme" , " dark" );
49+ storage .setItem (" language" , " en" );
50+
51+ // Later...
52+ const theme = storage .getItem (" theme" ); // null if expired
53+ ```
54+
2855## API
2956
3057### ` wrapStorage(originalStorage, options?) `
@@ -41,7 +68,7 @@ Wraps a Storage object to add expiration functionality.
4168
4269### ` cleanupFactory(originalStorage, options?) `
4370
44- Creates a cleanup function to wrap existing values and remove expired ones .
71+ Creates a cleanup function to remove expired values and optionally wrap unwrapped values so that they can be cleaned up later on as well .
4572
4673** Parameters:**
4774
0 commit comments