Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

expiry-set

SamVerschueren1.3kMIT1.0.0TypeScript support: included

A Set implementation with expirable keys

set, cache, caching, ttl, expire, expiring, expiry

readme

expiry-set

Build Status Coverage Status

A Set implementation with expirable keys

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.

  • expiry-map - A Map implementation with expirable items

License

MIT © Sam Verschueren