Skip to content

A Map implementation with expirable items

License

Notifications You must be signed in to change notification settings

tgunkel/expiry-map

 
 

Repository files navigation

expiry-map

Build Status Coverage Status

A Map implementation with expirable items

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

Install

$ npm install expiry-map

Usage

import ExpiryMap from 'expiry-map';

const map = new ExpiryMap(1000, [
	['unicorn', '🦄']
]);

map.get('unicorn');
//=> 🦄

map.set('rainbow', '🌈');

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

// Wait for 1 second...
map.get('unicorn');
//=> undefined

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

API

ExpiryMap(maxAge, [iterable])

maxAge

Type: number

Milliseconds until an item in the Map expires.

iterable

Type: Object

An Array or other iterable object whose elements are key-value pairs.

Instance

Any of the Map methods.

Related

License

MIT © Sam Verschueren

About

A Map implementation with expirable items

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%