base-helpers
Version:
Adds support for managing template helpers to your base application.
242 lines (153 loc) • 6.51 kB
Markdown
# base-helpers [](https://www.npmjs.com/package/base-helpers) [](https://npmjs.org/package/base-helpers) [](https://npmjs.org/package/base-helpers) [](https://travis-ci.org/node-base/base-helpers)
> Adds support for managing template helpers to your base application.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save base-helpers
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add base-helpers
```
## Usage
Register the plugin with your [base](https://github.com/node-base/base) application:
```js
var Base = require('base');
var helpers = require('base-helpers');
base.use(helpers());
```
## API
### [.helper](index.js#L50)
Register a template helper.
**Params**
* `name` **{String}**: Helper name
* `fn` **{Function}**: Helper function.
**Example**
```js
app.helper('upper', function(str) {
return str.toUpperCase();
});
```
### [.helpers](index.js#L71)
Register multiple template helpers.
**Params**
* `helpers` **{Object|Array}**: Object, array of objects, or glob patterns.
**Example**
```js
app.helpers({
foo: function() {},
bar: function() {},
baz: function() {}
});
```
### [.asyncHelper](index.js#L93)
Register an async helper.
**Params**
* `name` **{String}**: Helper name.
* `fn` **{Function}**: Helper function
**Example**
```js
app.asyncHelper('upper', function(str, next) {
next(null, str.toUpperCase());
});
```
### [.asyncHelpers](index.js#L117)
Register multiple async template helpers.
**Params**
* `helpers` **{Object|Array}**: Object, array of objects, or glob patterns.
**Example**
```js
app.asyncHelpers({
foo: function() {},
bar: function() {},
baz: function() {}
});
```
### [.getHelper](index.js#L137)
Get a previously registered helper.
**Params**
* `name` **{String}**: Helper name
* `returns` **{Function}**: Returns the registered helper function.
**Example**
```js
var fn = app.getHelper('foo');
```
### [.getAsyncHelper](index.js#L154)
Get a previously registered async helper.
**Params**
* `name` **{String}**: Helper name
* `returns` **{Function}**: Returns the registered helper function.
**Example**
```js
var fn = app.getAsyncHelper('foo');
```
### [.hasHelper](index.js#L173)
Return true if sync helper `name` is registered.
**Params**
* `name` **{String}**: sync helper name
* `returns` **{Boolean}**: Returns true if the sync helper is registered
**Example**
```js
if (app.hasHelper('foo')) {
// do stuff
}
```
### [.hasAsyncHelper](index.js#L191)
Return true if async helper `name` is registered.
**Params**
* `name` **{String}**: Async helper name
* `returns` **{Boolean}**: Returns true if the async helper is registered
**Example**
```js
if (app.hasAsyncHelper('foo')) {
// do stuff
}
```
### [.helperGroup](index.js#L214)
Register a namespaced helper group.
**Params**
* `helpers` **{Object|Array}**: Object, array of objects, or glob patterns.
**Example**
```js
// markdown-utils
app.helperGroup('mdu', {
foo: function() {},
bar: function() {},
});
// Usage:
// <%= mdu.foo() %>
// <%= mdu.bar() %>
```
## History
### v1.0.0
* upgrades dependencies to take advantage of improvements to [load-helpers](https://github.com/jonschlinkert/load-helpers) and [helper-cache](https://github.com/jonschlinkert/helper-cache). There shouldn't be any breaking changes here, so if you experience regressions please do not hesitate to [create an issue](../../new).
### v0.2.0
* adds support for passing helper groups as a function. For example, the `log` helper can be a function, but it can also have `log.warning` and `log.info` functions as properties.
## About
### Related projects
* [base-engines](https://www.npmjs.com/package/base-engines): Adds support for managing template engines to your base application. | [homepage](https://github.com/node-base/base-engines "Adds support for managing template engines to your base application.")
* [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://github.com/node-base/base-option) | [homepage](https://github.com/node-base/base-option "Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme for the full API.")
* [base-task](https://www.npmjs.com/package/base-task): base plugin that provides a very thin wrapper around [https://github.com/doowb/composer](https://github.com/doowb/composer) for adding task methods to… [more](https://github.com/node-base/base-task) | [homepage](https://github.com/node-base/base-task "base plugin that provides a very thin wrapper around <https://github.com/doowb/composer> for adding task methods to your application.")
* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base "Framework for rapidly creating high quality node.js applications, using plugins like building blocks")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 20, 2017._