This package has been deprecated

Author message:

Deprecated in favor of the 'expirables' package

@cadienvan/expirable-map

What is this?

This is a low footprint (~1.2KB) Map implementation that expires entries after a given time.

How do I install it?

You can install it by using the following command:

npm install @cadienvan/expirable-map

How to use it?

Simply import the module and start using it as follows:

import { ExpirableMap } from '@cadienvan/expirable-map';
const map = new ExpirableMap();
map.set('key', 'value');
map.get('key'); // "value"

You can also pass a third parameter to the set method to override the default expiration time (0) for that entry:

map.set('key', 'value', 2000); // 2000 is the expiration time in milliseconds for this entry

The ExpirableMap also has a setExpiration method which takes a key and a timeInMs arguments and expires the entry associated with that key after the specified expiration time:

map.setExpiration('key', 2000); // Expires the entry associated with the key "key" after 2000 milliseconds

Passing 0 as the expiration time will make the entry never expire:

map.set('key', 'value', 0); // The entry associated with the key "key" will never expire

How does this work?

The ExpirableMap constructor can take two arguments:

• options (Object): An object containing the following properties:
  • defaultTtl (Number): The default expiration time in milliseconds for the entries in the map. Defaults to 0 (never expires).
  • keepAlive (Boolean): Whether or not to keep alive (Re-start expiration timer) entries when set before expiring. Defaults to true.
• entries (Array): An array of entries to initialize the map with. Each entry is an array containing the following values:
  • key (Any): The key of the entry.
  • value (Any): The value of the entry.
  • ttl (Number): The expiration time in milliseconds for the entry. Defaults to defaultTtl. You can simply swap a Map with an ExpirableMap and it will work as expected.

What if I set a key that already exists?

The set method will override the previous entry and reset the timeout for that key if the keepAlive option is set to true (default). If it is set to false, the timeout will not be reset.

Tests

You can run the tests by using the following command:

npm test

Example

Run the example with the following script

npm run example

Scaffolding

This project was generated using Cadienvan's own npm-package-ts-scaffolding so it has all the necessary tools to develop, test and publish a TypeScript package importable both via CommonJS and ES Modules.