Package Exports

helper-cache

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (helper-cache) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

Set helpers on the cache.

key {String}: The name of the helper.
fn {Function}: Helper function.
returns {Object}: Return this to enable chaining

helpers.add('foo', function (name) {
  return 'foo-' + name;
});

addAsyncHelper

Set async helpers on the cache.

key {String}: The name of the helper.
fn {Function}: Helper function.
returns {Object}: Return this to enable chaining

helpers.addAsyncHelper('foo', function (name, next) {
  next(null, 'foo-' + name);
});

addHelpers

Add an object of helpers to the cache.

key {String}: The name of the helper.
fn {Function}: Helper function.
returns {Object}: Return this to enable chaining.

helpers.addHelpers({
  foo: function (name) {
    return 'foo-' + name;
  },
  bar: function (name) {
    return 'bar-' + name;
  }
});

### [addAsyncHelpers](index.js#L210)

Add an object of async helpers to the cache.

* `key` **{String}**: The name of the helper.    
* `fn` **{Function}**: Helper function.    
* `returns` **{Object}**: Return `this` to enable chaining  

```js
helpers.addAsyncHelpers({
  foo: function (name, next) {
    next(null, 'foo-' + name);
  },
  bar: function (name, next) {
    next(null, 'bar-' + name);
  }
});

### [getHelper](index.js#L234)

* `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](index.js#L252)

* `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](index.js#L271)

* `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](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert) 
 
**Brian Woodward**
 
+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/doowb) 


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

***

_This file was generated by [verb](https://github.com/assemble/verb) on December 17, 2014._


[load-helpers]: https://github.com/assemble/load-helpers