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

fwsp-cacher

v1.0.2

Published

A caching module for use with Node and Redis

Downloads

85

Readme

Cacher

A simple module for caching using Redis.

Introduction

Cacher is a wrapper module to abstract cache details and handling in order to make it easier for clients to simply get and set cached data.

Cacher has five public functions: init, setCachePrefix, getData, setData and setTTL. The most common methods you'll use after init will be the getData and setData methods.

####init

Used to initialize a cacher object with an object containing the address, port and database number for use with Redis.

let cacher = new Cacher();
cacher.init({
  url: '127.0.0.1',
  port: 6379,
  db: 1  
});

setCachePrefix

By default Cacher prefix keys in Redis with the word cacher. To specify an alternative prefix use the setCachePrefix member.

cacher.setCachePrefix('myAppName');

getData

/**
 * @name getData
 * @summary Retrieve data from cache using key.
 * @param {string} key - lookup key
 * @return {object} promise - promise resolving to value of key or rejection
 */
 getData(key)

setData

/**
 * @name setData
 * @summary Place data in cache based on key for a duration of cacheDurationInSeconds.
 * @param {string} key - lookup key
 * @param {object} data - data to store at key
 * @param {number} cacheDurationInSeconds - cache expiration
 * @return {object} promise - resolving to success or rejection
 */
 setData(key, data, cacheDurationInSeconds)

setTTL

/**
 * @name setTTL
 * @summary Set Time To Live for cache entry associated with key.
 * @param {string} key - key to set
 * @param {number} cacheDurationInSeconds - seconds to reset expiration to
 * @return {object} promise - resolving to success or rejection
 */
 setTTL(key, cacheDurationInSeconds)

Tests

This module contains tests in the specs folder.

To run them make sure you have mocha installed:

$ npm install mocha -g

Then run:

$ npm run test