Package Exports

helpers-utils

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 (helpers-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

helpers-utils

Utility methods commonly used for writing helper libraries.

Getting Started

To install the module, run the following in the command line:

npm i helpers-utils --save

Use within your application with the following line of JavaScript:

var utils = require('helpers-utils');

Usage

expects

Ensure that the expected API methods exist on an object.

var utils = require('helpers-utils');

var spec = {
  context: function() { return {}; },
  registerHelpers: function() { }
};

module.exports = function (config) {
  utils.expects(config, spec);

  Library.addHelper('greeting', function (userid) {
    var context = config.context();
    var name = context[userid] || 'Guest';
    return 'Hello ' + name;
  });
};

Contributing

Find a bug? Have a feature request? Please create an Issue.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and run docs in the command line to build the docs with Verb.

Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!

Author

Jon Schlinkert

Brian Woodward

License

This file was generated by verb-cli on March 23, 2014.