Open-cached

Standard cache function, Base on ioredis

Node version

Installation

npm install open-cached --save

Usage

const Redis = require("ioredis");
const _ = require("lodash");
const Cached = require('open-cached');

const redis = new Redis();
const cache = Cache(redis, _);

Table of Contents

• Cache
  • Parameters
  • get
    • Parameters
  • set
    • Parameters
  • del
    • Parameters
  • caching
    • Parameters

Cache

利用 redis 实现cache

Parameters

• redis object ioredis 实例
• _ object lodash 库

Returns Cache Instance

get

获取缓存的值

Parameters

• key string 缓存的 key

Returns Anyone 缓存的值

set

设置一个cache

Parameters

• key string 缓存的 key
• value string 缓存的值
• life number 有效期，单位秒，默认 0 永久有效 (optional, default 0)

Returns Anyone 缓存的值

del

删除缓存

Parameters

• key string 缓存的 key

Returns number 删除的条目数

caching

caching 让某个函数具有cache的能力

Parameters

• fn function 要加工的函数
• life number 缓存有效期，单位秒
• getKey function 计算缓存key的函数

Contributing

• Fork this repo
• Clone your repo
• Install dependencies
• Checkout a feature branch
• Feel free to add your features
• Make sure your features are fully tested
• Open a pull request, and enjoy <3

MIT license

Copyright (c) 2019 Open-node Author Redstone Zhao Email: [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.