storage-wrapper

StorageWrapper

A small utility for working with localStorage and sessionStorage in the browser, with support for type safety, expiration, and namespacing.

Features

• Get, set, and remove items with type safety.
• Expiration support for stored items.
• Namespacing for avoiding key collisions.

Installation

npm install storage-wrapper

Usage

TypeScript

import { StorageWrapper } from 'storage-wrapper';

const localStorageWrapper = new StorageWrapper('local', 'myApp');
const sessionStorageWrapper = new StorageWrapper('session', 'myApp');

// Setting items
localStorageWrapper.set('user', { name: 'John Doe' }, 30); // Expires in 30 minutes
sessionStorageWrapper.set('sessionID', 'abc123');

// Getting items
console.log(localStorageWrapper.get('user')); // { name: 'John Doe' }
console.log(sessionStorageWrapper.get('sessionID')); // 'abc123'

// Removing items
localStorageWrapper.remove('user');
sessionStorageWrapper.remove('sessionID');

// Clearing all items in the namespace
localStorageWrapper.clear();
sessionStorageWrapper.clear();

Event Listeners

const storageWithEvents = new StorageWrapper('local', 'myApp');

// Adding event listeners
storageWithEvents.on('set', 'print', (key, value) => {
  console.log(`Item set: ${key} = ${value}`);
});

storageWithEvents.on('remove', 'print', (key) => {
  console.log(`Item removed: ${key}`);
});

storageWithEvents.on('clear', 'print', () => {
  console.log('Storage cleared');
});

// Setting an item
storageWithEvents.set('key', 'value'); // Console: Item set: key = value

// Removing an item
storageWithEvents.remove('key'); // Console: Item removed: key

// Clearing storage
storageWithEvents.clear(); // Console: Storage cleared

API

StorageWrapper

constructor(storageType: 'local' | 'session', namespace?: string)

• storageType: Determines whether to use localStorage or sessionStorage.
• namespace: Optional namespace to avoid key collisions.

set(key: string, value: any, expirationInMinutes?: number): void

• key: The key under which the value is stored.
• value: The value to store.
• expirationInMinutes: Optional expiration time in minutes.

get<T>(key: string): T | null

• key: The key of the value to retrieve.
• Returns the value associated with the key, or null if the key doesn't exist or has expired.

remove(key: string): void

• key: The key of the value to remove.

clear(): void

• Clears all items within the namespace or all items if no namespace is specified.

on(event: 'set' | 'remove' | 'clear' | 'expired', event_name: string, callback: (key?: string, value?: any) => void): void

Demo

Check out the demo.

Contributing

This project is open to contributions. Feel free to open an issue or submit a pull request.

License

MIT