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

node-staticize

v1.1.2

Published

staticize middleware for expressjs sailsjs...

Downloads

4

Readme

node-staticize

Router staticize for express

SUPPORTS:

USE:

Cache:

  • api result
  • api view/render

Install

npm install node-staticize

Example

To use staticize in you module, simply import it:

var Staticize = require('staticize');

And set it (use memory or redis or others):

var staticize = new Staticize({
  cache : {
    adapter: 'redis',
    options: {
      host: '127.0.0.1',
      port: '6379'
    }
  },
  routes: {
    '/cache2s'    : 2,  // default GET method
    'get /cache3s': 3,
    'post /cache3s': 3,
    'get /foo/:bar': 5, // match /foo/whatever
    '/cacheCors': {
      ttl: 3,
      cors: 'http://yoursite.com' // allow 'http://yoursite.com' CORS access
    },
    '/cacheCorsForAll': {
      ttl: 3,
      cors: '*' // "*" to allow all domains CORS access
    }
  }
});

Then you can create a middleware:

staticize.cacheMiddleware() // set cache seconds, default 0 to skip

Use it:

  • expressjs:
app.use(staticize.cacheMiddleware());
app.use('/cache4s', staticize.cacheMiddleware(4));
app.use('/cacheCors', staticize.cacheMiddleware({ ttl: 3, cors: '*' }));

app.get('/*', function (req, res) {
  res.json({
    time: new Date().toLocaleString()
  });
});

app.listen(3000);
  • sailsjs:
// create a staticize.js under /policies
...
module.exports = staticize.cacheMiddleware(30);
...

// set it in policies.js
...
  'StaticizeController': {
    'test30s': ['staticize']
  }
...

new Staticize(options)

options.cache

cache config, include:

  • options.cache.adapter : type string, such as memory redis ...
  • options.cache.options : type object, if not use memory adapter, need to connect to Adapter, for example:
{
  ...
  cache: {
    adapter: 'redis',
    options: {
      host: '127.0.0.1',
  	  port: 6379
	}
  }
  ...
}

if given an unsupported adapter would throw a TypeError :

throw new Error('Unsupported cache adapter: ' + adapter);

[options.routes]

object , key is 'uri' or '${http method} uri' , value is cache seconds.

  1. When staticize.cacheMiddleware(30) with a ttl , staticize will use this ttl and NOT search in option.routes .
  2. When staticize.cacheMiddleware() with no ttl , staticize will search in option.routes :
    1. First search the 'uri' key, found and return;
    2. Then search the '${http method} uri' key, found and return;
    3. if not, return 0.

API

.cacheMiddleware(cacheTTL, skip, fn)

  1. cacheTTL is cache seconds.
  2. [skip] is a RegExp, if req.originalUrl.match(skip), goto next().
  3. fn is a function of using req to create a extension string adding to cache key.

Test

Run npm test .

Debug

Using debug.

LICENSE

MIT