$ npm install engine-handlebars
Handlebars engine, consolidate.js style but with enhancements. This works with Assemble, express.js, engine-cache or any application that follows consolidate.js conventions.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install with npm:
$ npm install --save engine-handlebars
There were major breaking changes in v1.0!.
const handlebars = require('handlebars');
const engine = require('engine-handlebars')(handlebars);
console.log(engine);
The engine object that is returned has the following properties:
name - the name of the engine: handlebars, used for engine detection in other libraries.instance - your instance of handlebarscompile - async compile methodcompileSync - sync compile methodrender - async render methodrenderSync - sync render methodCompile file.contents with handlebars.compile(). Adds a compiled .fn() property to the given file.
Params
file {Object}: File object with contents string or buffer.options {Object}: Options with partials and helpers.returns {Promise}Example
engine.compile({ contents: 'Jon {{ name }}' })
.then(file => {
console.log(typeof file.fn) // 'function'
});
Render file.contents with the function returned from .compile().
Params
file {Object}: File object with contents string or buffer.locals {Object}: Locals to use as contents to render the string.options {Object}: Options with partials and helpers.returns {Promise}Example
engine.render({ contents: 'Jon {{ name }}' }, { name: 'Schlinkert' })
.then(file => {
console.log(file.contents.toString()) // 'Jon Schlinkert'
});
Compile file.contents with handlebars.compile(). Adds a compiled .fn() property to the given file.
Params
file {Object}: File object with contents string or buffer.options {Object}: Options with partials and helpers.returns {Object}: Returns the file object.Example
let file = engine.compileSync({ contents: 'Jon {{ name }}' });
console.log(typeof file.fn) // 'function'
Render file.contents with the function returned from .compile().
Params
file {Object}: File object with contents string or buffer.locals {Object}: Locals to use as contents to render the string.options {Object}: Options with partials and helpers.returns {Object}: Returns the file object.Example
let file = engine.renderSync({ contents: 'Jon {{ name }}' }, { name: 'Schlinkert' });
console.log(file.contents.toString()) // 'Jon Schlinkert'
renderFile and __express have been removed..compile and .render now return a promise..compileSync and .renderSync may be used for sync operations.file object with a .contents property (string or buffer).renderFile now expects a vinyl file.engine.__expressPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running 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 test
(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 && verb
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 32 | jonschlinkert |
| 18 | doowb |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on November 11, 2018.