npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

soft-cache

v1.0.2

Published

A soft cache, key value pair,for node that contains a timeout on how long things stay on cache, default size is 1000 elements and 60 minutes to timeout

Downloads

4

Readme

Build status

node-soft-cache

https://www.npmjs.com/package/soft-cache

This library is an utility for caching in node.js. It emerged from the need of having something more than just var cache = {} in JavaScript. This cache behaves as a key value pair, allowing to set an expire timeout in the key/values that are put into the cache.

API

The caching constructor accepts two optional arguments:

  • The size of the cache, representing how many elements are allowed in it. Default value is 1000 slots.
  • The timeout value in milliseconds that will be used to expire the cache. Default value is 3600000 milliseconds (one hour).

Setting up a new cache

To construct the caching you just need to instantiate a new SoftCache().

var SoftCache = require("soft-cache"),
    softCache = new SoftCache(), // no arguments === default values

Or if you prefer to specify a size and custom timeout (in milliseconds):

    softCache = new SoftCache(SIZE, TIMEOUT);

Puting objects into the cache.

To insert objects you have the .put(key, value) function. This function receives an optional parameter if you want to force a different timeout in milliseconds .put(key, value, timeout).

var someObject = { foo:bar, 1:2 },
cache.put( "key1", someObject );

var someArray = [ 1, 2, 3 ];
cache.put( "key2", someArray );

// adding an object that will expire in 10 seconds
cache.put( "key3", anotherObject, 10000 );

Getting objects from the cache

To get an objet you just need to call .get( "aKey" ). If the item exists it will return itself.

var objectFromCache = cache.get( "key1" );

Removing an object from cache

To remove an object from cache you have available .remove( "someKey" ). This will remove the key value pair from the cache.

cache.remove( "key1" );

Remove all objects from caching

If you need to clear the cache and reset it to an empty state, thus releasing all cached values you can use the .clear().

cache.clear();