cachex

A cache hook

[![NPM version][npm-image]][npm-url]
[![codecov][cov-image]][cov-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/cachex.svg?style=flat-square
[npm-url]: https://npmjs.org/package/cachex
[cov-image]: https://codecov.io/gh/JacksonTian/cachex/branch/master/graph/badge.svg
[cov-url]: https://codecov.io/gh/JacksonTian/cachex
[download-image]: https://img.shields.io/npm/dm/cachex.svg?style=flat-square
[download-url]: https://npmjs.org/package/cachex

Features:

- No need to modify any existing code
- Auto generate cache key
- Auto serialize and deserialize data
- Built-in cache penetration solution

Installation

``sh
npm i cachex --save
`

Usage

If you have origin SQL query, it is db.js:

`js
async function getRows() {
// mock a slow query
return await db.query(sql);
}
`

Before use cachex, you must provide a cache storage, it can be redis or memcached or memory.

`js
var inMemory = {};

var store = {
get: async function (key) {
return inMemory[key];
},
setex: async function (key, value, expire) {
inMemory[key] = value;
setTimeout(function () {
delete inMemory[key];
}, expire);
}
};
`

The storage object must have get/setex method.

`js
// db_with_cache.js
import cachex from 'cachex';
import db from './db.js';

// cache result 10s
export const getRows = cachex(store, 'db', 'getRows', db.getRows, 10);
`

Running go:

`js
import dbx from './db_with_cache.js';
// from db
await dbx.getRows();

// from cache
await dbx.getRows();
// ..10s..pass..
// from db
await dbx.getRows();
`

$3

`js
import { createClient } from 'redis';

const redis = createClient({
// redis connection options
});
await redis.connect();

// cachex will auto serialize/deserialize
const store = {
get: async function (key) {
return await redis.GET(key);
},
setex: async function (key, value, expire) {
await redis.SETEX(key, expire, value);
}
};

// cache result 10s
export const getRows = cachex(store, 'db', 'getRows', db.getRows, 10);
``

License

The MIT license