Skip to content

Cache list (It is a list you can add items to, find out the length and retrieve the list... but the items expire some amount of time after being added)

License

Notifications You must be signed in to change notification settings

littlstar/expiration

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Expiration

For having an array of items that expire after a dynamic amount of time

Install:

npm install expiration

Quick Example:

const ExpireList = require('expiration')

const expireList = new ExpireList()

// Expire in 10s
expireList.add('hey!', 10000)

// Expire in 60s
expireList.add('bye!')

console.log(expireList.length) // 2

console.log(expireList.list) // [ 'hey!', 'bye!']

...

// 30s later

console.log(expireList.length) // 1

console.log(expireList.list) // [ 'bye!' ]

...

// 60s later

console.log(expireList.length) // 0

console.log(expireList.list) // []

Methods

constructor()

Creates a new expiring list

add(storeItem, timeToCache = 60000)

Adds the given item to the list and removes from the list in the given amount of milliseconds

Parameters:

  • storeItem - Object to store (can be a string, number, item, whatever)
  • timeToCache - Amount of milliseconds to store

length

How long is the list

list

What is the list at the given time

Notes:

Full example can be found under test/.

About

Cache list (It is a list you can add items to, find out the length and retrieve the list... but the items expire some amount of time after being added)

Resources

License

Stars

Watchers

Forks

Packages

No packages published