Giter Club home page Giter Club logo

node-taters's Introduction

taters Build Status

taters is an automatic resource hashing middleware for express. Injects resource fingerprints into static resource urls. Optionally inject a prefix for CDN deployments.

before

<head>
    <link href="/css/style.css">
</head>
<body>
    <script src="/js/index.js"></script>
</body>

after

<head>
    <link href="/static/1db360/css/style.css">
</head>
<body>
    <script src="/static/e9038a/js/index.js"></script>
</body>

And taters will add the appropriate cache expiry headers.

quickstart

var express = require('express');
var taters = require('taters');

var app = express();

app.set('view engine', 'hbs'); // or jade or whatevs
app.set('views', __dirname + '/views');

// let tater setup the magic
// you don't have to do anything else to get fingerprinting
app.use(taters({ cache: true || false });

// you can now serve static content with the regular static middleware
// no need to set a longer cachetime or anything since taters does that for us
app.use(express.static(__dirname + '/public'));

// render your views as before
// tater will replace script, link, img urls with fingerprinted ones
app.get('/', function(req, res, next) {
    res.render('index');
});

api

taters(opt, [middleware])

middleware is an optional function which will be called when /static/ middleware is encountered. You can do things like set longer expiries, better cache headers, etc...

By default, taters middleware sets an expiry of 1 year. This lets browsers, proxies, and CDNs cache the resource for a long time since the hash changes when the resource changes.

options

Taters accepts some options to configure behavior

option type default description
cache Boolean false true will cache url hashes to be cached
prefix String prefix all changed url with this path

CDN

Taters makes it very easy to use a CDN in production. Simply set the prefix option to the domain of your CDN and your resources will be served via CDN.

node-taters's People

Contributors

defunctzombie avatar marcello3d avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.