mb64-cache-client
v1.0.0
Published
Client SDK for MB64 Cache Server
Readme
mb64-cache-client
A lightweight and fast Node.js & Browser SDK for interacting with the MB64 Cache Server. Supports common cache operations such as GET, SET, DELETE, EXPIRE, STATS, FLUSH, LIST, and more.
🚀 Features
- Simple
connect(url)API - Promise-based methods
- Automatic JSON handling
- Supports TTL (expiry)
- Zero dependencies
- Works in NodeJS and Browsers
📦 Installation
npm install mb64-cache-client🕹️ Quick Start
import { connect } from "mb64-cache-client";
const client = connect("https://your-cache-server.com");
// SET (key, value, expiry in seconds)
await client.set("username", "manoj", 60);
// GET
const value = await client.get("username");
console.log(value);
// DELETE
await client.delete("username");
// EXPIRE existing key
await client.expire("session-token", 120);
// FLUSH ALL KEYS
await client.flush();
// LIST KEYS (page, limit)
const keys = await client.list(1, 50);
console.log(keys);
// SERVER STATS
console.log(await client.stats());📘 API Reference
connect(baseURL: string)
Creates a new client instance.
const client = connect("https://your-cache-server.com");client.set(key: string, value: any, expiry?: number)
Stores a value with optional expiry (in seconds).
await client.set("user", { name: "Manoj" }, 300);client.get(key: string)
Retrieves a value.
const user = await client.get("user");client.delete(key: string)
Deletes a key.
await client.delete("user");client.expire(key: string, seconds: number)
Updates the TTL of a key.
await client.expire("session", 120);client.flush()
Deletes all keys from cache.
await client.flush();client.list(page: number, limit: number)
Returns keys with pagination.
const keys = await client.list(1, 100);client.stats()
Fetches server statistics.
const stats = await client.stats();⚠️ Error Handling Example
try {
const value = await client.get("unknown");
console.log(value);
} catch (err) {
console.error("Cache Error:", err.message);
}📄 Example Project Structure
project/
│── src/
│ ├── index.js
│ └── cache.js
│── package.json
└── README.md🧪 Testing Using Node
node test.jsExample:
import { connect } from "mb64-cache-client";
(async () => {
const client = connect("http://localhost:8000");
await client.set("a", "b", 10);
console.log(await client.get("a"));
})();