acache-client v1.1.4

acache-client

acache-client is an npm package designed to interact with acache-server, a lightweight caching server. It provides two ways to use the client: as an npm package within code or as a CLI tool.

Installation

To use acache-client, install it locally in your project:

npm install acache-client

Or install it globally:

npm install -g acache-client

Usage

1. Using as an npm package in code

First, ensure that acache-server is running.

Example usage in a Node.js application:

const Acache = require('acache-client');

let host = '127.0.0.1', port = 6379;
// Create an instance of cache store
const cache = new Acache(host, port);

cache.on('open', () => console.log(`Caching is running on ${host}:${port}`))
    .on('error', (e) => console.log(e.message))
    .on('close', () => console.log('Connection closed'));

async function main() {
    
    await cache.nset('key', 5);
    console.log("value of key as number : ",await cache.nget('key')); // Output: number 5

    await cache.sset('key', 'string value', 50);
    console.log("value of key as string : ",await cache.sget('key')); // Output: string value

    await cache.bset('key', 1);
    console.log("value of key as string : ",await cache.bget('key')); // Output: true

    await cache.oset('key',
        {
            "name":"Jhon",
            "age":20,
            "hobby":["Football","Cricket","Party"],
            "address":{
                "city":"Los Angeles",
                "state":"California",
                "country":"United States"
            }
        });
    console.log("value of key as object : ",await cache.oget('key')); // Output: { name: 'Jhon', age: 20, hobby: [ 'Football', 'Cricket', 'Party' ], address: { city: 'Los Angeles', state: 'California', country: 'United States' } }
    
    await cache.sttl('num', 'key', 50); // Set TTL for number and return true on success

    console.log("TTL of key when it is string : ",await cache.gttl('str', 'key')); // Output: remaining TTL of key
    console.log("TTL of key when it is number : ",await cache.gttl('num', 'key')); // Output: remaining TTL of key

    await cache.rmttl('str', 'key'); // Remove TTL for key of string
    console.log("TTL of key when it is string : ",await cache.gttl('str', 'key')); // Output: null
}

main();

2. Using as a CLI tool

To use the CLI tool, ensure that acache-server is running. Then, start the CLI with:

acache-client

By default, it connects to 127.0.0.1:6379. To specify a custom host and port:

acache-client host port

Example,

acache-client 127.0.0.1 6379

If the package is not installed globally, use:

npx acache-client

Or with a custom host and port:

npx acache-client host port

CLI Command Examples

npx acache-cli 127.0.0.1 6379
Server connected to 127.0.0.1:6379
127.0.0.1:6379> sset key1 value1
127.0.0.1:6379> 1
127.0.0.1:6379> sget key1 
127.0.0.1:6379> "value1"
127.0.0.1:6379> nset key1 5
127.0.0.1:6379> 1
127.0.0.1:6379> nget key1 
127.0.0.1:6379> 5
127.0.0.1:6379> bset key1 1
127.0.0.1:6379> 1
127.0.0.1:6379> bget key1
127.0.0.1:6379> true
127.0.0.1:6379> oset key1 {"name":"Jhon","age":20,"hobby":["Football","Cricket","Party"],"address":{"city":"Los Angeles","state":"California","country":"United States"}}
127.0.0.1:6379> 1
127.0.0.1:6379> gttl str key1
127.0.0.1:6379> null
127.0.0.1:6379> sttl str key1 50
127.0.0.1:6379> 1
127.0.0.1:6379> gttl str key1
127.0.0.1:6379> 45.91
127.0.0.1:6379> rmttl str key1
127.0.0.1:6379> true
127.0.0.1:6379> gttl str key1
127.0.0.1:6379> null
127.0.0.1:6379> exit

Supported Operations

License

This project is licensed under the Apache-2.0 License.