load-helpers

Load helpers with patterns, as an object, key-value pair, or module.

Install

Install with npm:

$ npm install --save load-helpers

Install with yarn:

$ yarn add load-helpers

API

Loader

Create an instance of Loader with the given options.

Params

options {Object}

Example

var Loader = require('load-helpers');
var loader = new Loader();

.addHelper

Params

name {String}
fn {Function}
options {Object}

Example

loader.addHelper('foo', function() {
  // do stuff
});

.addHelpers

Params

helpers {Object}
options {Object}

Example

loader.addHelpers({
  foo: function() {},
  bar: function() {},
  baz: function() {}
});

Load one or more helpers from a filepath, glob pattern, object, or an array of any of those things. This method detects the type of value to be handled then calls one of the other methods to do the actual loading.

Params

helpers {Object}
options {Object}
returns {Object}: Returns the views from loader.helpers

Example

var loader = new Loader();
console.log(loader.load(['foo/*.hbs', 'bar/*.hbs']));
console.log(loader.load({path: 'a/b/c.md'}));
console.log(loader.load('index', {path: 'a/b/c.md'}));

options.renameHelper

Customize how dynamically-added helpers are named as they're loaded.

Examples

Pass a custom renameHelper function on the ctor.

var loader = new Loader({
  renameHelper: function(key) {
    // simple camel-case
    return key.replace(/\W(.)/g, function(_, ch) {
      return ch.toUpperCase();
    });
  }
});

loader.load('for-own');
console.log(loader.helpers);
// { 'forOwn': [Function: forOwn] }

Or to only renamed specific helpers, you can pass the renameHelper function to any of the methods.

loader.load('for-own', {
  renameHelper: function(key) {
    // simple camel-case
    return key.replace(/\W(.)/g, function(_, ch) {
      return ch.toUpperCase();
    });
  }
});
console.log(loader.helpers);
// { 'forOwn': [Function: forOwn] }

About

Related projects

handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
helper-cache: Easily register and get helper functions to be passed to any template engine or node.js… more | homepage
template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage

Contributing

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

Contributors

Commits	Contributor
39	jonschlinkert
3	doowb

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.5.0, on April 20, 2017.

Current Tags

1.0.1 ... latest (8 years ago)

load-helpers

Install

API

Loader

.addHelper

.addHelpers

.load

options.renameHelper

About

Related projects

Contributing

Contributors

Building docs

Running tests

Author

License

Current Tags

17 Versions