base-helpers

base-helpers

Adds support for managing template helpers to your base application.

Install

Install with npm:

$ npm install --save base-helpers

Usage

Register the plugin with your base application:

var Base = require('base');
var helpers = require('base-helpers');
base.use(helpers());

API

.helper

Register a template helper.

Params

• name {String}: Helper name
• fn {Function}: Helper function.

Example

app.helper('upper', function(str) {
  return str.toUpperCase();
});

.helpers

Register multiple template helpers.

Params

• helpers {Object|Array}: Object, array of objects, or glob patterns.

Example

app.helpers({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});

.asyncHelper

Register an async helper.

Params

• name {String}: Helper name.
• fn {Function}: Helper function

Example

app.asyncHelper('upper', function(str, next) {
  next(null, str.toUpperCase());
});

.asyncHelpers

Register multiple async template helpers.

Params

• helpers {Object|Array}: Object, array of objects, or glob patterns.

Example

app.asyncHelpers({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});

.getHelper

Get a previously registered helper.

Params

• name {String}: Helper name
• returns {Function}: Returns the registered helper function.

Example

var fn = app.getHelper('foo');

.getAsyncHelper

Get a previously registered async helper.

Params

• name {String}: Helper name
• returns {Function}: Returns the registered helper function.

Example

var fn = app.getAsyncHelper('foo');

.hasHelper

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

if (app.hasHelper('foo')) {
  // do stuff
}

.hasAsyncHelper

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

if (app.hasAsyncHelper('foo')) {
  // do stuff
}

.helperGroup

Register a namespaced helper group.

Params

• helpers {Object|Array}: Object, array of objects, or glob patterns.

Example

// markdown-utils
app.helperGroup('mdu', {
  foo: function() {},
  bar: function() {},
});

// Usage:
// <%= mdu.foo() %>
// <%= mdu.bar() %>

History

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: Adds support for managing template engines to your base application. | homepage
• base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage
• base-task: base plugin that provides a very thin wrapper around https://github.com/doowb/composer for adding task methods to… more | homepage
• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.4.1, on January 17, 2017.