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

@civic/simple-cache

v1.0.1

Published

A simple cache function

Downloads

12

Readme

A function that produces a cached version of the input function, where, similarly to _.memoize, function calls with the same parameters will be cached and returned.

Unlike _.memoize, the cached values will expire after ttl milliseconds (default 1hr)

const cache = require('simple-cache');

function slowRarelyChangingFunction(a, b) {
  ...
}

const cachedFn = cache(slowRarelyChangingFunction, { ttl: <ttl in ms>})
const result1 = cachedFn(1, 2); // cache miss - slow
const result2 = cachedFn(3, 4); // cache miss - slow
const result3 = cachedFn(1, 2); // cache hit - fast

The underlying cache is available at cachedFn.cache.

The results are stored in the cache as follows:

JSON.stringify(decycle(arguments)) -> result

The arguments are stringified in order to allow subsequent lookups on argument lists that have the same contents, but are not equal in terms of JS equality (===).

To avoid problems with stringification, the arguments are decycled first using the json-cycle library.

This process has two important side-effects:

Note 1: The decycling and stringification can be expensive - so this cache should not be used for complex object inputs (e.g. large DOM trees) Note 2: Since WeakMap does not allow String keys, we use Map here. This can lead to memory leaks if a service runs for a long time.

To mitigate memory leaks, the function provides access to the underlying cache via cachedFn.cache. You can clear the cache by calling:

cachedFn.cache = new Map();

or you can pass any implementation you like of the Map interface, in order to control the cache size.

You can also manipulate the arguments before they get stringified, for example, in order to remove arguments that are not suitable to be used as a cache key.

const negate = (a, logger) => {
    logger.log(a);
    return !a
}
const ignoreSecondArgument = cache(negate, { convertArgFn: a => a });