express.js inspired template-engine manager.
Install with npm:
$ npm install --save engine-cacheInstall with yarn:
$ yarn add engine-cachevar Engines = require('engine-cache');Params
engines{Object}: Optionally pass an object of engines to initialize with.
Example
var Engines = require('engine-cache');
var engines = new Engines();Register the given view engine callback fn as ext.
Params
ext{String}options{Object|Function}: or callbackfn.fn{Function}: Callback.returns{Object}Engines: to enable chaining.
Example
var consolidate = require('consolidate')
engines.setEngine('hbs', consolidate.handlebars)Add an object of engines onto engines.cache.
Params
obj{Object}: Engines to load.returns{Object}Engines: to enable chaining.
Example
engines.setEngines(require('consolidate'))Return the engine stored by ext. If no ext is passed, undefined is returned.
Params
ext{String}: The engine to get.returns{Object}: The specified engine.
Example
var consolidate = require('consolidate');
var engine = engine.setEngine('hbs', consolidate.handlebars);
var engine = engine.getEngine('hbs');
console.log(engine);
// => {render: [function], renderFile: [function]}Get and set helpers for the given ext (engine). If no ext is passed, the entire helper cache is returned.
Example:
See helper-cache for 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.getEngineHelper('bar');
helpers.getEngineHelper();v0.19.0 ensure the string is only rendered once by passing the compiled function to the render method
v0.18.0 the .load method was renamed to .setHelpers
v0.16.0 the .clear() method was removed. A custom inspect method was added.
v0.15.0 .getEngine() no longer returns the entire cache object when ext is undefined.
- assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
- 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
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 113 | jonschlinkert |
| 51 | doowb |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testJon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.5.0, on April 20, 2017.