engine-cache

engine-cache

express.js inspired template-engine manager.

Changes

HEADS UP! as of v0.15.0, .getEngine() no longer returns the entire cache object when ext is undefined.

Install

Install with npm

$ npm i engine-cache --save

Usage

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

API

Engines

Params

• engines {Object}: Optionally pass an object of engines to initialize with.

Example

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

.setEngine

Register the given view engine callback fn as ext.

Params

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

Example

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

.getEngine

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

Params

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

Example

var consolidate = require('consolidate')
engine.setEngine('hbs', consolidate.handlebars);

engine.getEngine('hbs');
// => {render: [function], renderFile: [function]}

.load

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

Params

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

Example

engines.load(require('consolidate'))

.helpers

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

Example:

See helper-cachefor any related issues, API details, and documentation.

Params

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

Example

var helpers = engines.helpers('hbs');
helpers.addHelper('bar', function() {});
helpers.getHelper('bar');
helpers.getHelper();

.clear

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

Example:

Params

• ext {String}: The engine to remove.

Example

engines.clear()

Related

• async-helpers: Use async helpers in templates with engines that typically only handle sync helpers. Handlebars and… more | homepage
• engines: Template engine library with fast, synchronous rendering, based on consolidate. | homepage
• helper-cache: Easily register and get helper functions to be passed to any template engine or node.js… more | homepage
• templates: System for creating and managing template collections, and rendering templates with any node.js template engine.… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on September 17, 2015.