Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/icai/node-cache

node cache provider using mongodb, redis, memcache, lru, mysql, file.
https://github.com/icai/node-cache

cache file-cache memcache mongodb mongodb-cache mysql-cache node-cache redis redis-cache

Last synced: about 1 month ago
JSON representation

node cache provider using mongodb, redis, memcache, lru, mysql, file.

Host: GitHub
URL: https://github.com/icai/node-cache
Owner: icai
License: mit
Created: 2019-05-29T02:41:44.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2019-06-02T12:55:11.000Z (over 5 years ago)
Last Synced: 2024-09-30T00:14:20.208Z (about 2 months ago)
Topics: cache, file-cache, memcache, mongodb, mongodb-cache, mysql-cache, node-cache, redis, redis-cache
Language: TypeScript
Homepage: https://www.npmjs.com/package/node-caches
Size: 61.5 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# node-cache
node cache provider using redis, memcache, lru, mysql, file

## Install

```
npm i node-caches --save

```

you need to install some dependencies for provider.

- Mysql
```
npm i sequelize mysql2 --save
```
- Memcache
```
npm i memcache-plus sequelize mysql2 --save
```
- File
```
npm i cacache --save
```
- Redis
```
npm i ioredis --save
```
- LRU
```
npm i lru-cache --save
```
- Mongodb
```
npm i mongoose --save

```

## Setup

```js

import { config } from 'node-caches'

```

mysql

```js
mysql = config({
store: 'mysql',
options: {
database: 'ncache',
username: 'root',
password: 'root123456',
host: 'localhost'
}
})

```

`options` parameters will be passed to http://docs.sequelizejs.com/class/lib/sequelize.js~Sequelize.html#instance-constructor-constructor

memcache

```js
mem = config({
store: 'memcache',
options: {
hosts: ['127.0.0.1:11211'],
mysql: {
database: 'ncache',
username: 'root',
password: 'root123456',
host: 'localhost'
}
}
})

```

`options` parameters will be passed to https://github.com/victorquinn/memcache-plus/blob/master/docs/initialization.md#options

`options.mysql` parameters will be passed to http://docs.sequelizejs.com/class/lib/sequelize.js~Sequelize.html#instance-constructor-constructor

file

```js
file = config({
store: 'file',
options: {
path: path.resolve(__dirname, '.cache')
}
})
```

redis

```js
redis = config({
store: 'redis',
options: {
port: 6379,
host: '127.0.0.1'
}
})
```
`options` parameters will be passed to https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new

lru

```js
lru = config({
store: 'lru',
options: {
max: 500,
maxAge: 1000 * 60 * 60
}
})
```

`options` parameters will be passed to https://github.com/isaacs/node-lru-cache#options

mongodb

```js
mongodb = config({
store: 'mongodb',
options: {
url: 'mongodb://localhost:27017'
}
})
```

## implements ICache API

```js
export interface ICache {
read: Function,
write: Function,
delete: Function,
search: Function,
clean: Function
}
```

Also see the [API Documentation](API.md)

## LICENSE