About

LocalStorage is a straightforward key-value store that enables data storage within the browser.

LocalCache is a library that enhances LocalStorage's capabilities by introducing caching features. This means you can store data in the browser with the added benefit of automatic expiration after a specified time.

LocalCache offers an easy-to-use API for setting, retrieving, and clearing data.

Essentially, it's like LocalStorage with a Time-To-Live (TTL) functionality.

💻 Usage

1. Installation using npm:

npm install local-storage-ttl-cache

2. Import it into your project:

import { LocalCache } from "local-storage-ttl-cache";

🤖 Example

import { LocalCache } from "local-storage-ttl-cache";

// Set a key-value pair with a TTL of 5 seconds
LocalCache.set("MyTestKey", "MyValue", 5000);

// Retrieve the value
const value = LocalCache.get("MyTestKey");
console.log(value); // Output: MyValue

// Wait for 5 seconds
setTimeout(() => {
	// Retrieve the value after the TTL has expired
	const value = LocalCache.get("MyTestKey");
	console.log(value); // Output: null
}, 5000);

// Set and delete
LocalCache.set("MyOtherTestKey", "MyValue"); // No TTL (Live forever)
LocalCache.delete("MyOtherTestKey");
const testValue = LocalCache.get("MyOtherTestKey");
console.log(testValue); // Output: null

// Check if it exists
const exists = LocalCache.exists("MyOtherTestKey");
console.log(exists); // Output: false

// Get the remaining time before expiration
LocalCache.set("MyTest", "MyValue", 5000);
const remainingTime = LocalCache.ttl("MyTest");
console.log(remainingTime); // Output: ~5000

⭐ API Guide

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

Set a key-value pair with an optional TTL (in milliseconds).

LocalCache.set("MyKey", "MyValue", 5000);

get(key: string): any | null

Get the value of a key.

const value = LocalCache.get("MyKey");

delete(key: string): void

Delete a key-value pair.

LocalCache.delete("MyKey");

exists(key: string): boolean

Checks if a key exists.

const exists = LocalCache.exists("MyKey"); // Output: true or false

ttl(key: string): number

Check the remaining time before expiration.

const remainingTime = LocalCache.ttl("MyKey"); // Output: ~5000 milliseconds or -1 if the key does not exist

clear(): void

Clears all keys.

LocalCache.clear();