shakyShane / cache-breaker

Cache Breaking tasks
4 stars 9 forks source link

Cache Breaking Tasks Build Status

Note: This modules does nothing with the file system, that means you'll have to read/write files yourself, or wait for the Grunt & Gulp Plugins

Install

npm install cache-breaker

Use in project

var cacheBreaker = require("cache-breaker");

Usage Examples

Append a timestamp as query string

var string   = '<link href="https://github.com/shakyShane/cache-breaker/blob/master/style.css" /><link href="https://github.com/shakyShane/cache-breaker/blob/master/style2.css" />';

cacheBreaker.breakCache(string, ['style.css', 'style2.css']);

// output
// <link href="https://github.com/shakyShane/cache-breaker/blob/master/style.css?rel=23452341" /><link href="https://github.com/shakyShane/cache-breaker/blob/master/style2.css?rel=23452341" />

Append a timestamp in the filename

var string   = '<link href="https://github.com/shakyShane/cache-breaker/blob/master/style.css" />';

cacheBreaker.breakCache(string, 'style.css', {position: 'filename'});

// output
// <link href="https://github.com/shakyShane/cache-breaker/blob/master/style.56432352.css" />

Overwrite an exiting timestamp

Use this when you have rewrite rules in place.

var string   = '<link href="https://github.com/shakyShane/cache-breaker/blob/master/style.2452345.css" />';

cacheBreaker.breakCache(string, 'style.*.css', {position: 'overwrite'});

// output
// <link href="https://github.com/shakyShane/cache-breaker/blob/master/style.56432352.css" />

TODO