engine-cache

engine-cache

express.js inspired template-engine manager.

Install

Install with npm

npm i engine-cache --save

Usage

var engines = require('engine-cache');

API

Engines

• options {Object}: Default options to use.

var Engines = require('engine-cache');
var engines = new Engines();

.register

Register the given view engine callback fn as ext.

• ext {String}
• options {Object|Function}: or callback fn.
• fn {Function}: Callback.
• returns {object} engines: to enable chaining.

var consolidate = require('consolidate')
engines.register('hbs', consolidate.handlebars)

.wrapEngine

Wrap an engine to extend the helpers object and other native methods or functionality.

• engine {Object}: The engine to wrap.
• returns {Object} engine: The wrapped engine.

engines.wrapEngine(engine);

.load

Load an object of engines onto the cache. Mostly useful for testing, but exposed as a public method.

• obj {Object}: Engines to load.
• returns {object} engines: to enable chaining.

engines.load(require('consolidate'))

.get

Return the engine stored by ext. If no ext is passed, the entire cache is returned.

• ext {String}: The engine to get.
• returns {Object}: The specified engine.

var consolidate = require('consolidate')
engine.set('hbs', consolidate.handlebars)
engine.get('hbs')
// => {render: [function], renderFile: [function]}

.helpers

• ext {String}: The helper cache to get and set to.
• returns {Object}: Object of helpers for the specified engine.

Get and set helpers for the given ext (engine). If no ext is passed, the entire helper cache is returned.

.clear

Remove ext engine from the cache, or if no value is specified the entire cache is reset.

• ext {String}: The engine to remove.

Example:

engines.clear()

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

---

This file was generated by verb-cli on August 29, 2014.