{{foo}}
\n\n \n{{bar}}
\n\n\n\n```\n\n#### More on Helpers\n\nRefer to the [Handlebars website][] for more information on defining helpers:\n\n* [Expression Helpers][]\n* [Block Helpers][]\n\n### Metadata\n\nHandlebars has a data channel feature that propagates data through all scopes, including helpers and partials. Values in the data channel can be accessed via the `{{@variable}}` syntax. Express Handlebars provides metadata about a template it renders on a `{{@exphbs}}` object allowing access to things like the view name passed to `res.render()` via `{{@exphbs.view}}`.\n\nThe following is the list of metadata that's accessible on the `{{@exphbs}}` data object:\n\n* `cache`: Boolean whether or not the template is cached.\n* `encoding`: String name of encoding for files.\n* `view`: String name of the view passed to `res.render()`.\n* `layout`: String name of the layout view.\n* `data`: Original data object passed when rendering the template.\n* `helpers`: Collection of helpers used when rendering the template.\n* `partials`: Collection of partials used when rendering the template.\n* `runtimeOptions`: Runtime Options used to render the template.\n\n\n[examples directory]: https://github.com/express-handlebars/express-handlebars/tree/master/examples\n[view cache setting]: https://expressjs.com/en/api.html#app.settings.table\n[Express locals]: https://expressjs.com/en/api.html#app.locals\n[registered with Handlebars]: https://github.com/wycats/handlebars.js/#registering-helpers\n[built-in helpers]: https://handlebarsjs.com/guide/builtin-helpers.html\n[Handlebars website]: https://handlebarsjs.com/\n[Expression Helpers]: https://handlebarsjs.com/guide/#custom-helpers\n[Block Helpers]: https://handlebarsjs.com/guide/#block-helpers\n\n\n## API\n\n### Configuration and Defaults\n\nThere are two main ways to use this package: via its engine factory function, or creating `ExpressHandlebars` instances; both use the same configuration properties and defaults.\n\n```javascript\nimport { engine, create, ExpressHandlebars } from 'express-handlebars';\n\n// Using the engine factory:\nengine({ /* config */ });\n\n// Create an instance:\ncreate({ /* config */ });\n\n// Using the class:\nnew ExpressHandlebars({ /* config */})\n```\n\nThe following is the list of configuration properties and their default values (if any):\n\n#### `handlebars=require('handlebars')`\nThe Handlebars module/implementation. This allows for the `ExpressHandlebars` instance to use a different Handlebars module/implementation than that provided by the Handlebars npm package.\n\n#### `extname=\".handlebars\"`\nThe string name of the file extension used by the templates. This value should correspond with the `extname` under which this view engine is registered with Express when calling `app.engine()`.\n\nThe following example sets up an Express app to use `.hbs` as the file extension for views:\n\n```javascript\nimport express from 'express';\nimport { engine } from 'express-handlebars';\n\nconst app = express();\n\napp.engine('.hbs', engine({extname: '.hbs'}));\napp.set('view engine', '.hbs');\napp.set('views', './views');\n```\n\n**Note:** Setting the app's `\"view engine\"` setting will make that value the default file extension used for looking up views.\n\n#### `encoding=\"utf8\"`\nDefault encoding when reading files.\n\n#### `layoutsDir`\nDefault layouts directory is relative to `express settings.view` + `layouts/`\nThe string path to the directory where the layout templates reside.\n\n**Note:** If you configure Express to look for views in a custom location (e.g., `app.set('views', 'some/path/')`), and if your `layoutsDir` is not relative to `express settings.view` + `layouts/`, you will need to reflect that by passing an updated path as the `layoutsDir` property in your configuration.\n\n#### `partialsDir`\nDefault partials directory is relative to `express settings.view` + `partials/`\nThe string path to the directory where the partials templates reside or object with the following properties:\n\n* `dir`: The string path to the directory where the partials templates reside.\n* `namespace`: Optional string namespace to prefix the partial names.\n* `templates`: Optional collection (or promise of a collection) of templates in the form: `{filename: template}`.\n* `rename(filePath, namespace)`: Optional function to rename the partials. Takes two arguments: `filePath`, e.g., `partials/some/path/template.handlebars` and `namespace`.\n\n**Note:** If you configure Express to look for views in a custom location (e.g., `app.set('views', 'some/path/')`), and if your `partialsDir` is not relative to `express settings.view` + `partials/`, you will need to reflect that by passing an updated path as the `partialsDir` property in your configuration.\n\n**Note:** Multiple partials dirs can be used by making `partialsDir` an array of strings, and/or config objects as described above. The namespacing feature is useful if multiple partials dirs are used and their file paths might clash.\n\n#### `defaultLayout`\nThe string name or path of a template in the `layoutsDir` to use as the default layout. `main` is used as the default. This is overridden by a `layout` specified in the app or response `locals`. **Note:** A falsy value will render without a layout; e.g., `res.render('home', {layout: false});`. You can also use a falsy value when creating the engine to make using no layout a default e.g. `app.engine('.hbs', exphbs({defaultLayout: false}));`.\n\n#### `helpers`\nAn object which holds the helper functions used when rendering templates with this `ExpressHandlebars` instance. When rendering a template, a collection of helpers will be generated by merging: `handlebars.helpers` (global), `helpers` (instance), and `options.helpers` (render-level). This allows Handlebars' `registerHelper()` function to operate as expected, will providing two extra levels over helper overrides.\n\n#### `compilerOptions`\nAn object which holds options that will be passed along to the Handlebars compiler functions: `Handlebars.compile()` and `Handlebars.precompile()`.\n\n#### `runtimeOptions`\nAn object which holds options that will be passed along to the template function in addition to the `data`, `helpers`, and `partials` options. See [Runtime Options][] for a list of available options.\n\n### Properties\n\nThe public API properties are provided via `ExpressHandlebars` instances. In additional to the properties listed in the **Configuration and Defaults** section, the following are additional public properties:\n\n#### `engine`\nA function reference to the `renderView()` method which is bound to `this` `ExpressHandlebars` instance. This bound function should be used when registering this view engine with an Express app.\n\n#### `extname`\nThe normalized `extname` which will _always_ start with `.` and defaults to `.handlebars`.\n\n#### `compiled`\nAn object cache which holds compiled Handlebars template functions in the format: `{\"path/to/template\": [Function]}`.\n\n#### `precompiled`\nAn object cache which holds precompiled Handlebars template strings in the format: `{\"path/to/template\": [String]}`.\n\n### Methods\n\nThe following is the list of public API methods provided via `ExpressHandlebars` instances:\n\n**Note:** All of the public methods return a [`Promise`][promise] (with the exception of `renderView()` which is the interface with Express.)\n\n#### `getPartials([options])`\nRetrieves the partials in the `partialsDir` and returns a Promise for an object mapping the partials in the form `{name: partial}`.\n\nBy default each partial will be a compiled Handlebars template function. Use `options.precompiled` to receive the partials as precompiled templates ā this is useful for sharing templates with client code.\n\n**Parameters:**\n\n* `[options]`: Optional object containing any of the following properties:\n\n * `[cache]`: Whether cached templates can be used if they have already been requested. This is recommended for production to avoid unnecessary file I/O.\n\n * `[encoding]`: File encoding.\n\n * `[precompiled=false]`: Whether precompiled templates should be provided, instead of compiled Handlebars template functions.\n\nThe name of each partial corresponds to its location in `partialsDir`. For example, consider the following directory structure:\n\n```\nviews\nāāā partials\n āāā foo\n āĀ Ā āāā bar.handlebars\n āāā title.handlebars\n\n2 directories, 2 files\n```\n\n`getPartials()` would produce the following result:\n\n```javascript\nimport { create } from 'express-handlebars';\n\nconst hbs = create();\nhbs.getPartials().then(function (partials) {\n console.log(partials);\n // => { 'foo/bar': [Function],\n // => title: [Function] }\n});\n```\n\n#### `getTemplate(filePath, [options])`\nRetrieves the template at the specified `filePath` and returns a Promise for the compiled Handlebars template function.\n\nUse `options.precompiled` to receive a precompiled Handlebars template.\n\n**Parameters:**\n\n* `filePath`: String path to the Handlebars template file.\n\n* `[options]`: Optional object containing any of the following properties:\n\n * `[cache]`: Whether a cached template can be used if it have already been requested. This is recommended for production to avoid necessary file I/O.\n\n * `[encoding]`: File encoding.\n\n * `[precompiled=false]`: Whether a precompiled template should be provided, instead of a compiled Handlebars template function.\n\n#### `getTemplates(dirPath, [options])`\nRetrieves all the templates in the specified `dirPath` and returns a Promise for an object mapping the compiled templates in the form `{filename: template}`.\n\nUse `options.precompiled` to receive precompiled Handlebars templates ā this is useful for sharing templates with client code.\n\n**Parameters:**\n\n* `dirPath`: String path to the directory containing Handlebars template files.\n\n* `[options]`: Optional object containing any of the following properties:\n\n * `[cache]`: Whether cached templates can be used if it have already been requested. This is recommended for production to avoid necessary file I/O.\n\n * `[encoding]`: File encoding.\n\n * `[precompiled=false]`: Whether precompiled templates should be provided, instead of a compiled Handlebars template function.\n\n#### `resetCache([filePathsOrFilter])`\nReset template cache. The cache can be partially reset by providing a filter argument. If no argument is given the whole cache will be reset.\n\n**Parameters:**\n\n* `[filePathsOrFilter]`: Optional filter to reset part of the cache. This can be a file path, an array of file paths, or a filter function based on file path.\n\n#### `render(filePath, context, [options])`\nRenders the template at the specified `filePath` with the `context`, using this instance's `helpers` and partials by default, and returns a Promise for the resulting string.\n\n**Parameters:**\n\n* `filePath`: String path to the Handlebars template file.\n\n* `context`: Object in which the template will be executed. This contains all of the values to fill into the template.\n\n* `[options]`: Optional object which can contain any of the following properties which affect this view engine's behavior:\n\n * `[cache]`: Whether a cached template can be used if it have already been requested. This is recommended for production to avoid unnecessary file I/O.\n\n * `[encoding]`: File encoding.\n\n * `[data]`: Optional object which can contain any data that Handlebars will pipe through the template, all helpers, and all partials. This is a side data channel.\n\n * `[helpers]`: Render-level helpers that will be used instead of any instance-level helpers; these will be merged with (and will override) any global Handlebars helper functions.\n\n * `[partials]`: Render-level partials that will be used instead of any instance-level partials. This is used internally as an optimization to avoid re-loading all the partials.\n\n * `[runtimeOptions]`: Optional object which can contain options passed to the template function.\n\n#### `renderView(viewPath, options|callback, [callback])`\nRenders the template at the specified `viewPath` as the `{{{body}}}` within the layout specified by the `defaultLayout` or `options.layout`. Rendering will use this instance's `helpers` and partials, and passes the resulting string to the `callback`.\n\nThis method is called by Express and is the main entry point into this Express view engine implementation. It adds the concept of a \"layout\" and delegates rendering to the `render()` method.\n\nThe `options` will be used both as the context in which the Handlebars templates are rendered, and to signal this view engine on how it should behave, e.g., `options.cache=false` will _always_ load the templates from disk.\n\n**Parameters:**\n\n* `viewPath`: String path to the Handlebars template file which should serve as the `{{{body}}}` when using a layout.\n\n* `[options]`: Optional object which will serve as the context in which the Handlebars templates are rendered. It may also contain any of the following properties which affect this view engine's behavior:\n\n * `[cache]`: Whether cached templates can be used if they have already been requested. This is recommended for production to avoid unnecessary file I/O.\n\n * `[encoding]`: File encoding.\n\n * `[data]`: Optional object which can contain any data that Handlebars will pipe through the template, all helpers, and all partials. This is a side data channel.\n\n * `[helpers]`: Render-level helpers that will be merged with (and will override) instance and global helper functions.\n\n * `[partials]`: Render-level partials will be merged with (and will override) instance and global partials. This should be a `{partialName: fn}` hash or a Promise of an object with this shape.\n\n * `[layout]`: Optional string path to the Handlebars template file to be used as the \"layout\". This overrides any `defaultLayout` value. Passing a falsy value will render with no layout (even if a `defaultLayout` is defined).\n\n * `[runtimeOptions]`: Optional object which can contain options passed to the template function.\n\n* `callback`: Function to call once the template is retrieved.\n\n### Hooks\n\nThe following is the list of protected methods that are called internally and serve as _hooks_ to override functionality of `ExpressHandlebars` instances. A value or a promise can be returned from these methods which allows them to perform async operations.\n\n#### `_compileTemplate(template, options)`\nThis hook will be called when a Handlebars template needs to be compiled. This function needs to return a compiled Handlebars template function, or a promise for one.\n\nBy default this hook calls `Handlebars.compile()`, but it can be overridden to preform operations before and/or after Handlebars compiles the template. This is useful if you wanted to first process Markdown within a Handlebars template.\n\n**Parameters:**\n\n* `template`: String Handlebars template that needs to be compiled.\n\n* `options`: Object `compilerOptions` that were specified when the `ExpressHandlebars` instance as created. This object should be passed along to the `Handlebars.compile()` function.\n\n#### `_precompileTemplate(template, options)`\nThis hook will be called when a Handlebars template needs to be precompiled. This function needs to return a serialized Handlebars template spec. string, or a promise for one.\n\nBy default this hook calls `Handlebars.precompile()`, but it can be overridden to preform operations before and/or after Handlebars precompiles the template. This is useful if you wanted to first process Markdown within a Handlebars template.\n\n**Parameters:**\n\n* `template`: String Handlebars template that needs to be precompiled.\n\n* `options`: Object `compilerOptions` that were specified when the `ExpressHandlebars` instance as created. This object should be passed along to the `Handlebars.compile()` function.\n\n#### `_renderTemplate(template, context, options)`\nThis hook will be called when a compiled Handlebars template needs to be rendered. This function needs to returned the rendered output string, or a promise for one.\n\nBy default this hook simply calls the passed-in `template` with the `context` and `options` arguments, but it can be overridden to perform operations before and/or after rendering the template.\n\n**Parameters:**\n\n* `template`: Compiled Handlebars template function to call.\n\n* `context`: The context object in which to render the `template`.\n\n* `options`: Object that contains options and metadata for rendering the template:\n\n * `data`: Object to define custom `@variable` private variables.\n\n * `helpers`: Object to provide custom helpers in addition to the globally defined helpers.\n\n * `partials`: Object to provide custom partials in addition to the globally defined partials.\n\n * `...runtimeOptions`: Other options specified by the `runtimeOptions` value.\n\n\n[promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\n[Runtime Options]: https://handlebarsjs.com/api-reference/runtime-options.html\n\n\n## Examples\n\n### [Basic Usage][]\n\nThis example shows the most basic way to use this view engine.\n\n### [Advanced Usage][]\n\nThis example is more comprehensive and shows how to use many of the features of this view engine, including helpers, partials, multiple layouts, etc.\n\nAs noted in the **Package Design** section, this view engine's implementation is instance-based, and more advanced usages can take advantage of this. The Advanced Usage example demonstrates how to use an `ExpressHandlebars` instance to share templates with the client, among other features.\n\n\n[Basic Usage]: https://github.com/express-handlebars/express-handlebars/tree/master/examples/basic\n[Advanced Usage]: https://github.com/express-handlebars/express-handlebars/tree/master/examples/advanced\n\n\nLicense\n-------\n\nThis software is free to use under the Yahoo! Inc. BSD license. See the [LICENSE file][] for license text and copyright information.\n\n\n[LICENSE file]: https://github.com/express-handlebars/express-handlebars/blob/master/LICENSE\n","readmeFilename":"README.md","users":{"52u":true,"jk6":true,"ace11":true,"dizid":true,"ericf":true,"jostw":true,"junhc":true,"mllee":true,"71emj1":true,"alek-s":true,"emoket":true,"h0ward":true,"hyteer":true,"ibambo":true,"iliyat":true,"kachar":true,"kenkao":true,"kudakv":true,"majgis":true,"omar84":true,"3ddario":true,"arielfr":true,"cubesun":true,"drewigg":true,"gruebes":true,"itonyyo":true,"justsso":true,"kimemin":true,"mlyihgw":true,"mr_eaze":true,"neraliu":true,"onemoon":true,"simioni":true,"subchen":true,"tomchao":true,"andypang":true,"ashifatb":true,"bebeskin":true,"davepoon":true,"djamseed":true,"frankl83":true,"kingcron":true,"krabello":true,"shieldax":true,"brave_cgx":true,"chunxchun":true,"codeofzen":true,"elkdanger":true,"guiyuzhao":true,"hehaiyang":true,"mikelsito":true,"namgil.ko":true,"snowdream":true,"vonmauser":true,"andruwhart":true,"electblake":true,"lonekorean":true,"piecioshka":true,"sanketss84":true,"sean-oneal":true,"this-harsh":true,"fearnbuster":true,"jamesbedont":true,"knownasilya":true,"luuhoangnam":true,"rubenjose75":true,"sessionbean":true,"ivangaravito":true,"jakedemonaco":true,"keeyanajones":true,"mobeicaoyuan":true,"viktorivanov":true,"wesleylhandy":true,"leelandmiller":true,"montyanderson":true,"swapnil_mishra":true,"billpatrianakos":true,"charlietango592":true,"sametsisartenep":true}}