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

@seneca/cache

v4.2.1

Published

In-memory caching plugin for seneca

Downloads

28

Readme

Seneca

A Seneca.js in-memory caching plugin.

seneca-cache

npm version Build Status Coverage Status DeepScan grade Dependency Status Gitter

Description

This module is a plugin for the Seneca framework. It provides a set of common caching actions (get, set etc.), backed by lru-cache. It also exposes some lru-cache specific actions (peek, has, keys, values, reset).

By moving cache operations into Seneca, you can change your cache implementation or business rules at a later point. For example, you might decide to send certain kinds of keys to a different cache mechanism, such as redis.

Install

npm install seneca
npm install seneca-cache

Quick example

This code snippet sets a value and then retrieves it.

var seneca = require('seneca')();
seneca.use('cache');

seneca.ready(function(err) {
  seneca.act({role: 'cache', cmd: 'set', key: 'k1', val: 'v1'}, function(err) {
    seneca.act({role: 'cache', cmd: 'get', key: 'k1'}, function(err, out) {
      console.log('value = ' + out)
    });
  });
});

Options

  • micro.expiry : number 11111

Set plugin options when loading with:



seneca.use('cache', { name: value, ... })

Note: foo.bar in the list above means { foo: { bar: ... } }

Action Patterns

Action Descriptions

« role:cache,cmd:add »

No description provided.


« role:cache,cmd:clear »

No description provided.


« role:cache,cmd:decr »

No description provided.


« role:cache,cmd:delete »

No description provided.


« role:cache,cmd:get »

No description provided.


« role:cache,cmd:incr »

No description provided.


« role:cache,cmd:micro »

No description provided.


« role:cache,cmd:micro,get:stats »

No description provided.


« role:cache,cmd:set »

No description provided.


« role:cache,get:native »

No description provided.


« role:lrucache,cmd:has »

No description provided.


« role:lrucache,cmd:keys »

No description provided.


« role:lrucache,cmd:peek »

No description provided.


« role:lrucache,cmd:reset »

No description provided.


« role:lrucache,cmd:values »

No description provided.


Common Cache API

Seneca has a common caching API with the following actions:

  • role:cache, cmd:set store a value - key and val arguments required
  • role:cache, cmd:get retreive a value - key argument is required
  • role:cache, cmd:add store a value, only if the key does not exist - key and val arguments required
  • role:cache, cmd:delete delete a value - key argument is required, no error if key does not exist
  • role:cache, cmd:incr increment a value - key and val (integer) arguments required
  • role:cache, cmd:decr decrement a value - key and val (integer) arguments required

All caching plugins, including this one, implement this action API.

Options

You can use any of the options from the lru-cache module directly as options to this plugin:

seneca.use('cached', {
  lrucache: {
    max: 1000,
    maxAge: 1000 * 60 * 60,
    length: function(n) {return n.length}
  }
});

Contributing

The Senecajs org encourages open participation. If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

Test

mocha test/cache.test.js

License

Copyright (c) 2014-2020, Richard Rodger, Seamus D'Arcy and other contributors. Licensed under MIT.