helper-cache

helper-cache

Easily get and set helper functions to pass to any application or template engine.

Install

Install with npm:

npm i helper-cache --save-dev

API

Helpers

Create an instance of Helpers, optionally passing default options.

• options {Object}: Default options to use.
  • bind {Boolean}: Bind functions to this. Defaults to false.
  • thisArg {Boolean}: The context to use.

var Helpers = require('helper-cache');
var helpers = new Helpers();

addHelper

• key {String}: The name of the helper.
• fn {Function}: Helper function.

Set helpers on the cache.

addAsyncHelper

• key {String}: The name of the helper.
• fn {Function}: Helper function.

Set async helpers on the cache.

addHelpers

Add an object of helpers to the cache.

• key {String}: The name of the helper.
• fn {Function}: Helper function.

See load-helpers for issues, API details and the full range of options.

addAsyncHelpers

Add an object of async helpers to the cache.

• key {String}: The name of the helper.
• fn {Function}: Helper function.

See load-helpers for issues, API details and the full range of options.

getHelper

• key {String}: The helper to get.
• returns {Object}: The specified helper. If no key is passed, the entire cache is returned.

Get a helper from the cache.

getAsyncHelper

• key {String}: The helper to get.
• returns {Object}: The specified helper. If no key is passed, the entire cache is returned.

Get an async helper from the cache.

resolve

• content {String}: Rendered string containing async ids
• cb {Function}

Getter method to resolve async helper values that were called during the render process.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

Brian Woodward

• github/doowb
• twitter/doowb

License

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

---

This file was generated by verb on December 17, 2014.