blob: 471d93353a07ecc09022a17da6aa88c6bcf18e18 (
plain)
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
57
58
59
60
61
62
63
64
65
66
67
|
# map-age-cleaner
[](https://travis-ci.org/SamVerschueren/map-age-cleaner) [](https://codecov.io/gh/SamVerschueren/map-age-cleaner?branch=master)
> Automatically cleanup expired items in a Map
## Install
```
$ npm install map-age-cleaner
```
## Usage
```js
import mapAgeCleaner from 'map-age-cleaner';
const map = new Map([
['unicorn', {data: '🦄', maxAge: Date.now() + 1000}]
]);
mapAgeCleaner(map);
map.has('unicorn');
//=> true
// Wait for 1 second...
map.has('unicorn');
//=> false
```
> **Note**: Items have to be ordered ascending based on the expiry property. This means that the item which will be expired first, should be in the first position of the `Map`.
## API
### mapAgeCleaner(map, [property])
Returns the `Map` instance.
#### map
Type: `Map`
Map instance which should be cleaned up.
#### property
Type: `string`<br>
Default: `maxAge`
Name of the property which olds the expiry timestamp.
## Related
- [expiry-map](https://github.com/SamVerschueren/expiry-map) - A `Map` implementation with expirable items
- [expiry-set](https://github.com/SamVerschueren/expiry-set) - A `Set` implementation with expirable keys
- [mem](https://github.com/sindresorhus/mem) - Memoize functions
## License
MIT © [Sam Verschueren](https://github.com/SamVerschueren)
|
