base-helpers

base-helpers

Adds support for managing template helpers to your base application.

Install

$ npm install --save base-helpers

$ yarn add base-helpers

Usage

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

API

.helper

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

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

.helpers

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

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

.asyncHelper

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

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

.asyncHelpers

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

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

.getHelper

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

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

.getAsyncHelper

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

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

.hasHelper

• name {String}: sync helper name
• returns {Boolean}: Returns true if the sync helper is registered

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

.hasAsyncHelper

• name {String}: Async helper name
• returns {Boolean}: Returns true if the async helper is registered

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

.helperGroup

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

// 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 and helper-cache. There shouldn't be any breaking changes here, so if you experience regressions please do not hesitate to create an issue.

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: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage

Contributing

Building docs

$ npm install -g verbose/verb#dev verb-generate-readme && verb

$ npm install && npm test