UNPKG

time-cache

Version:

A key-value cache that puts a expiry date on its entries.

github.com/diasdavid/time-cache

diasdavid/time-cache

56 lines (36 loc) • 1.41 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
time-cache ========== [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![Build Status](https://travis-ci.org/diasdavid/time-cache.svg?style=flat-square)](https://travis-ci.org/diasdavid/time-cache) [![Coverage Status](https://coveralls.io/repos/github/diasdavid/time-cache/badge.svg?branch=master)](https://coveralls.io/github/diasdavid/time-cache?branch=master) [![Dependency Status](https://david-dm.org/diasdavid/time-cache.svg?style=flat-square)](https://david-dm.org/diasdavid/time-cache) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) > A key-value cache that puts a expiry date on its entries. ## Table of Contents - [Install](#install) - [npm](#npm) - [Usage](#usage) - [Example](#example) - [API](#api) - [Contribute](#contribute) - [License](#license) ## Install ### npm ```sh > npm install time-cache ``` ## Usage ### Example ```js // TODO (see tests meanwhile) ``` ## API ### Create a time-cache `const tc = new TimeCache(options)` ### Add a value `tc.put(key, value, validity)` ### Has a value `tc.has(key)` ### Get a value `tc.get(key)` ## Contribute Contributions are welcome! ## License MIT