Welcome to Cache-Base: A Comprehensive Guide

Cache-Base is a powerful and flexible caching solution designed to enhance the performance of your web applications. This guide will introduce you to the key APIs provided by Cache-Base and demonstrate how to use them effectively with practical code snippets.

Setting Up Cache-Base

  
    const cache = require('cache-base');
    const appCache = new cache();
  

Basic Usage

Store a key-value pair in the cache:

  
    appCache.set('name', 'John Doe');
  

Retrieve a value from the cache:

  
    const name = appCache.get('name');
    console.log(name); // Output: John Doe
  

Check if a key exists in the cache:

  
    const hasName = appCache.has('name');
    console.log(hasName); // Output: true
  

Delete a key from the cache:

  
    appCache.del('name');
  

Advanced Usage

Set a key with a time-to-live (TTL):

  
    appCache.set('tempData', 'This will expire', { maxAge: 60000 });
  

Set multiple key-value pairs at once:

  
    appCache.set({
      'user1': 'Alice',
      'user2': 'Bob'
    });
  

Load and dump cache data:

  
    const data = { 'cachedItem': 'This is saved' };
    appCache.load(data);
    
    const dumpedData = appCache.dump();
    console.log(dumpedData);
  

Get all keys in the cache:

  
    const keys = appCache.keys();
    console.log(keys); // Output: [ 'user1', 'user2', 'cachedItem' ]
  

Application Example

Let’s build a simple Node.js application that uses Cache-Base to store and retrieve user sessions:

  
    const express = require('express');
    const cache = require('cache-base');
    const appCache = new cache();
    
    const app = express();
    app.use(express.json());
    
    // Middleware to simulate user login
    app.post('/login', (req, res) => {
      const { userId } = req.body;
      appCache.set(`session_${userId}`, { loggedIn: true, userId: userId });
      res.send('User logged in');
    });
    
    // Middleware to check user session
    app.get('/profile', (req, res) => {
      const { userId } = req.query;
      const session = appCache.get(`session_${userId}`);
      
      if (session && session.loggedIn) {
        res.send(`Welcome User ${session.userId}`);
      } else {
        res.status(401).send('Please log in');
      }
    });
    
    app.listen(3000, () => {
      console.log('Server running on port 3000');
    });
  

By leveraging Cache-Base in your applications, you can ensure efficient data retrieval and enhanced performance, making it a valuable addition to your development toolkit.

Hash: 9f4c79e54a619d10ed4fc17b71a75a73f0e18e9eec54a57a0aceeb67eb4d38c2