Skip to content

SamVerschueren/expiry-set

Repository files navigation

expiry-set

Build Status Coverage Status

A Set implementation with expirable keys

Memory is automatically released when an item expires by removing it from the Set.

Install

$ npm install expiry-set

Usage

import ExpirySet from 'expiry-set';

const set = new ExpirySet(1000, [
	'unicorn'
]);

set.has('unicorn');
//=> true

set.add('rainbow');

console.log(set.size);
//=> 2

// Wait for 1 second...
set.has('unicorn');
//=> false

console.log(set.size);
//=> 0

API

ExpirySet(maxAge, [iterable])

maxAge

Type: number

Milliseconds until a key in the Set expires.

iterable

Type: Object

An Array or other iterable object.

Instance

Any of the Set methods.

Related

License

MIT © Sam Verschueren

About

A Set implementation with expirable keys

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors