egg-cache

KO | EN

gitlite — search

#python #hacktoberfest #typescript #llm #android #machine-learning #deep-learning #macos #windows #awesome #cli #vue #mcp #ios

(★ 64)

💾 Cache plugin for eggjs

egg-cache Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# egg-cache

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-cache.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-cache
[travis-image]: https://img.shields.io/travis/hexindai/egg-cache.svg?style=flat-square
[travis-url]: https://travis-ci.org/hexindai/egg-cache
[codecov-image]: https://img.shields.io/codecov/c/github/hexindai/egg-cache.svg?style=flat-square
[codecov-url]: https://codecov.io/github/hexindai/egg-cache?branch=master
[david-image]: https://img.shields.io/david/hexindai/egg-cache.svg?style=flat-square
[david-url]: https://david-dm.org/hexindai/egg-cache
[snyk-image]: https://snyk.io/test/npm/egg-cache/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-cache
[download-image]: https://img.shields.io/npm/dm/egg-cache.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-cache

Based on [cache-manager](https://github.com/BryanDonovan/node-cache-manager)

All store engine based on [cache-manager](https://github.com/BryanDonovan/node-cache-manager) can be used.
* [Store engine](https://github.com/BryanDonovan/node-cache-manager#store-engines)
* [Configuration reference](#add-store)

[中文文档](README.zh_CN.md)

## Installation

```sh
npm i egg-cache -S
```

```sh
yarn add egg-cache
```

## Configuration

```js
// config/plugin.js
exports.cache = {
  enable: true,
  package: 'egg-cache',
};
```

```js
// config/config.default.js
exports.cache = {
  default: 'memory',
  stores: {
    memory: {
      driver: 'memory',
      max: 100,
      ttl: 0,
    },
  },
};
```
## Usage

```js
await app.cache.set('foo', 'bar', 60, { foo: 'bar' });

await app.cache.get('foo'); // 'bar'

await app.cache.has('foo'); // true

await app.cache.del('foo');
await app.cache.get('foo', 'default');  // 'default'

await app.cache.has('foo'); // false

// closure
await app.cache.set('foo', () => {
  return 'bar';
}); // 'bar'

// Promise
await app.cache.set('foo', () => {
  return Promise.resolve('bar');
});  // 'bar'

// Get cached value. If it's not existed, get and save the value from closure
await app.cache.get('foo', () => {
  return 'bar';
}); // 'bar'

// You can declare an `expire` option
await app.cache.get('foo', () => {
  return 'bar';
}, 60, {
  foo: 'bar'
});

//  foo was cached
await app.cache.get('foo'); // 'bar'

// clear cache
await app.cache.reset();
```

### Add store

1. config: the `store` in the configuration uses the `driver` instead.

```js
// config/config.default.js

const redisStore = require('cache-manager-ioredis');

exports.cache = {
  default: 'memory',
  stores: {
    memory: {
      driver: 'memory',
      max: 100,
      ttl: 0,
    },
    redis: { // full config: https://github.com/dabroek/node-cache-manager-ioredis#single-store
      driver: redisStore,
      host: 'localhost',
      port: 6379,
      password: '',
      db: 0,
      ttl: 600,
      valid: _ => _ !== null,
    },
  },
};
```

2. usage

```js
const store = app.cache.store('redis');

await store.set('foo', 'bar');
await store.get('foo'); // 'bar'

await store.del('foo');
await store.has('foo'); // false
```

### Api

#### cache.set(name, value, [expire=null, options=null]);

Set Cache
 - `name` cache name
 - `value` cache value
 - `expire` (Optional) expire（default from config file，the unit is second， `0` means *nerver* expire）
 - `options` (Optional) Refer to [cache-manager](https://github.com/BryanDonovan/node-cache-manager/blob/master/lib/stores/memory.js#L14-L18))

#### cache.get(name, [defaultValue=null, expire=null, options=null]);

#### cache.del(name);

#### cache.has(name);

#### cache.store(name, [options=null]);

#### cache.reset();

## Default configuration

Refer to [config/config.default.js](config/config.default.js)

## Unit Test

```sh
npm test
```

## Issue

Refer to [Issues](https://github.com/hexindai/egg-cache/issues).

## License

[MIT](LICENSE)

egg-cache

egg-cache Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

egg-cache

egg-cache Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README