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

litter-box

v2.0.2

Published

A modified catbox

Downloads

6

Readme

litter-box

A few function memoization helpers to work with catbox.

standard travis npm

Promise Memoization

litterBox.memoizeFnPromise(options)

Arguments

  • options: object. Required. An object with the following keys:
    • client: Catbox Client Instance. Required. A catbox client instance.
    • fn: Function. Required. A function which returns a Promise.
    • ttl: Integer. Required. The time-to-live for the cached fn result.
    • keyProvider: (fn-input) => {id, segment}. Required. A function which returns a cache-key for Catbox. This function is called with the same arguments as fn, allowing you to create a dynamic cache-key, for example:
  const exampleKeyProvider = (input) => ({ segment: 'test', id: `test-${input}` })

Promise Memoization Example:

This code is also available here.

const litterBox = require('litter-box')

const examplePromiseFunction = (input) => Promise.resolve(input)

const cachedPromiseFunction = litterBox.memoizeFnPromise({
  client: catboxClientInstance,
  fn: examplePromiseFunction,
  keyProvider: (input) => ({ segment: 'test', id: `test-${input}` }),
  ttl: 5 * 60 * 1000 // 5 minutes
})

cachedPromiseFunction(1234)
  .then(console.log) // prints 1234

// later on...
cachedPromiseFunction(1234) // function not executed, value is pulled from the cache
  .then((result) => { // returns 1234
    console.log(result)
    process.exit(0)
  })

Callback Memoization

litterBox.memoizeFnCallback(options)

Arguments

  • options: object. Required. An object with the following keys:
    • client: Catbox Client Instance. Required. A catbox client instance.
    • fn: Function. Required. A function which has a callback as it's final argument.
    • ttl: Integer. Required. The time-to-live for the cached fn result.
    • keyProvider: (fn-input) => {id, segment}. Required. A function which returns a cache-key for Catbox. This function is called with the same arguments as fn, allowing you to create a dynamic cache-key, for example:
  const exampleKeyProvider = (input) => ({ segment: 'test', id: `test-${input}` })

Callback Memoization Example:

This code is also available here.

const litterBox = require('litter-box')

const exampleCallbackFunction = (input, cb) => cb(null, input)

const cachedCallbackFunction = litterBox.memoizeFnPromise({
  client: catboxClientInstance,
  fn: exampleCallbackFunction,
  keyProvider: (input) => ({ segment: 'test', id: `test-${input}` }),
  ttl: 5 * 60 * 1000 // 5 minutes
})

cachedCallbackFunction(1234, (err, result) => console.log(result)) // prints 1234

// later on...

// function not executed, value is pulled from the cache
cachedCallbackFunction(1234, (err, result) => console.log(result)) // prints 1234

l