Skip to content

Commit

Permalink
Merge branch 'patch-1' of https://github.com/jschall/consolidate.js i…
Browse files Browse the repository at this point in the history
…nto jschall-patch-1
  • Loading branch information
doowb committed Sep 18, 2017
2 parents f75f02a + 65e0e45 commit 1b0d6ed
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,9 @@ cons.swig('views/page.html', { user: 'tobi' })

## Caching

To enable or disable caching simply pass `{ cache: true/false }`. Engines _may_ use this option to cache things reading the file contents, compiled `Function`s etc. Engines which do _not_ support this may simply ignore it. All engines that consolidate.js implements I/O for will cache the file contents, ideal for production environments.

```js
var cons = require('consolidate');
cons.swig('views/page.html', { cache: false, user: 'tobi' }, function(err, html){
if (err) throw err;
console.log(html);
});
```
To enable caching simply pass `{ cache: true }`. Engines _may_ use this option to cache things reading the file contents, compiled `Function`s etc. Engines which do _not_ support this may simply ignore it. All engines that consolidate.js implements I/O for will cache the file contents, ideal for production environments.
When using consolidate directly: `cons.swig('views/page.html', { user: 'tobi', cache:true }, callback);`
Using Express 3 or higher: `app.locals.cache = true` or set NODE_ENV to 'production' and Express will do this for you.

## Express 3.x example

Expand Down

0 comments on commit 1b0d6ed

Please sign in to comment.