{"_id":"base-helpers","_rev":"231871","name":"base-helpers","description":"Adds support for managing template helpers to your base application.","dist-tags":{"latest":"1.0.0"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T15:46:44.000Z","created":"2016-06-01T06:19:48.107Z","1.0.0":"2017-04-20T06:39:48.925Z","0.2.0":"2017-01-17T09:32:48.441Z","0.1.1":"2016-06-10T03:16:47.519Z","0.1.0":"2016-06-01T06:19:48.107Z"},"users":{},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/node-base/base-helpers.git"},"versions":{"1.0.0":{"name":"base-helpers","description":"Adds support for managing template helpers to your base application.","version":"1.0.0","homepage":"https://github.com/node-base/base-helpers","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/node-base/base-helpers.git"},"bugs":{"url":"https://github.com/node-base/base-helpers/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"debug":"^2.6.3","helper-cache":"^1.0.0","is-valid-app":"^0.3.0","isobject":"^3.0.0"},"devDependencies":{"base":"^0.13.0","gulp-format-md":"^0.1.12","mocha":"^3.2.0"},"keywords":["api","app","application","async","base","base-plugin","baseplugin","building-blocks","create","engine","framework","helper","helpers","plugin","plugins","render","template","templates","tool","toolkit","tools"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["base","base-engines","base-option","base-task"]},"reflinks":["base","helper-cache","load-helpers"],"lint":{"reflinks":true}},"gitHead":"7d9dfbc102d1b3812e91e73fbfbb5358a24b5134","_id":"base-helpers@1.0.0","_shasum":"e693085b121247e0fe8a0bb5cbbc305e0c172680","_from":".","_npmVersion":"4.2.0","_nodeVersion":"7.7.3","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"e693085b121247e0fe8a0bb5cbbc305e0c172680","size":4367,"noattachment":false,"key":"/base-helpers/-/base-helpers-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/base-helpers/download/base-helpers-1.0.0.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/base-helpers-1.0.0.tgz_1492670387062_0.4580093929544091"},"directories":{},"publish_time":1492670388925,"_hasShrinkwrap":false,"_cnpm_publish_time":1492670388925},"0.2.0":{"name":"base-helpers","description":"Adds support for managing template helpers to your base application.","version":"0.2.0","homepage":"https://github.com/node-base/base-helpers","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/node-base/base-helpers.git"},"bugs":{"url":"https://github.com/node-base/base-helpers/issues"},"license":"MIT","files":["index.js","utils.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"debug":"^2.6.0","define-property":"^0.2.5","is-valid-app":"^0.2.1","isobject":"^3.0.0","lazy-cache":"^2.0.2","load-helpers":"^0.3.1"},"devDependencies":{"base":"^0.11.1","gulp-format-md":"^0.1.11","mocha":"^3.2.0"},"keywords":["api","app","application","async","base","baseplugin","building-blocks","create","engine","framework","helper","helpers","plugin","plugins","render","template","templates","tool","toolkit","tools"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["base","base-engines","base-option","base-task"]},"reflinks":["base","verb","verb-readme-generator"],"lint":{"reflinks":true}},"gitHead":"7d9dfbc102d1b3812e91e73fbfbb5358a24b5134","_id":"base-helpers@0.2.0","_shasum":"75a9494bb8c059ff3d7943829cf755047bfe10d7","_from":".","_npmVersion":"3.10.9","_nodeVersion":"6.9.2","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"75a9494bb8c059ff3d7943829cf755047bfe10d7","size":4696,"noattachment":false,"key":"/base-helpers/-/base-helpers-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/base-helpers/download/base-helpers-0.2.0.tgz"},"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/base-helpers-0.2.0.tgz_1484645567524_0.25796767813153565"},"directories":{},"publish_time":1484645568441,"_cnpm_publish_time":1484645568441,"_hasShrinkwrap":false},"0.1.1":{"name":"base-helpers","description":"Adds support for managing template helpers to your base application.","version":"0.1.1","homepage":"https://github.com/node-base/base-helpers","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/node-base/base-helpers.git"},"bugs":{"url":"https://github.com/node-base/base-helpers/issues"},"license":"MIT","files":["index.js","utils.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"debug":"^2.2.0","define-property":"^0.2.5","is-valid-app":"^0.1.0","lazy-cache":"^2.0.1","load-helpers":"^0.2.11"},"devDependencies":{"base":"^0.11.0","gulp-format-md":"^0.1.9","mocha":"^2.5.3"},"keywords":["app","async","base","baseplugin","engine","helper","helpers","render","template","templates"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["base","base-engines","base-option","base-task"]},"reflinks":["base","verb","verb-readme-generator"],"lint":{"reflinks":true}},"gitHead":"541fd29a152e7e896a543df80e2c064ef2f1abb4","_id":"base-helpers@0.1.1","_shasum":"da4e1e2b2f8008ecdce93f11efddb6de06333fb3","_from":".","_npmVersion":"3.8.9","_nodeVersion":"6.2.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"da4e1e2b2f8008ecdce93f11efddb6de06333fb3","size":2769,"noattachment":false,"key":"/base-helpers/-/base-helpers-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/base-helpers/download/base-helpers-0.1.1.tgz"},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/base-helpers-0.1.1.tgz_1465528605245_0.5177371548488736"},"directories":{},"publish_time":1465528607519,"_cnpm_publish_time":1465528607519,"_hasShrinkwrap":false},"0.1.0":{"name":"base-helpers","description":"Adds support for managing template helpers to your base application.","version":"0.1.0","homepage":"https://github.com/node-base/base-helpers","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/node-base/base-helpers.git"},"bugs":{"url":"https://github.com/node-base/base-helpers/issues"},"license":"MIT","files":["index.js","utils.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"debug":"^2.2.0","define-property":"^0.2.5","is-valid-app":"^0.1.0","lazy-cache":"^2.0.1","load-helpers":"^0.2.10"},"devDependencies":{"base":"^0.8.1","gulp-format-md":"^0.1.9","is-valid-app":"^0.1.0","mocha":"^2.5.3"},"keywords":[],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["base","base-option","base-task","base-engines"]},"reflinks":["verb","base"],"lint":{"reflinks":true}},"gitHead":"37b4267f9a1cef83d8490af085c37c49cb3f3bc5","_id":"base-helpers@0.1.0","_shasum":"fecb37bb05eff85fe093bf649849a6d6f80aecc4","_from":".","_npmVersion":"3.8.9","_nodeVersion":"6.2.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"fecb37bb05eff85fe093bf649849a6d6f80aecc4","size":2719,"noattachment":false,"key":"/base-helpers/-/base-helpers-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/base-helpers/download/base-helpers-0.1.0.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/base-helpers-0.1.0.tgz_1464761985831_0.37878102832473814"},"directories":{},"publish_time":1464761988107,"_cnpm_publish_time":1464761988107,"_hasShrinkwrap":false}},"readme":"# base-helpers [![NPM version](https://img.shields.io/npm/v/base-helpers.svg?style=flat)](https://www.npmjs.com/package/base-helpers) [![NPM monthly downloads](https://img.shields.io/npm/dm/base-helpers.svg?style=flat)](https://npmjs.org/package/base-helpers)  [![NPM total downloads](https://img.shields.io/npm/dt/base-helpers.svg?style=flat)](https://npmjs.org/package/base-helpers) [![Linux Build Status](https://img.shields.io/travis/node-base/base-helpers.svg?style=flat&label=Travis)](https://travis-ci.org/node-base/base-helpers)\n\n> Adds support for managing template helpers to your base application.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save base-helpers\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add base-helpers\n```\n\n## Usage\n\nRegister the plugin with your [base](https://github.com/node-base/base) application:\n\n```js\nvar Base = require('base');\nvar helpers = require('base-helpers');\nbase.use(helpers());\n```\n\n## API\n\n### [.helper](index.js#L50)\n\nRegister a template helper.\n\n**Params**\n\n* `name` **{String}**: Helper name\n* `fn` **{Function}**: Helper function.\n\n**Example**\n\n```js\napp.helper('upper', function(str) {\n  return str.toUpperCase();\n});\n```\n\n### [.helpers](index.js#L71)\n\nRegister multiple template helpers.\n\n**Params**\n\n* `helpers` **{Object|Array}**: Object, array of objects, or glob patterns.\n\n**Example**\n\n```js\napp.helpers({\n  foo: function() {},\n  bar: function() {},\n  baz: function() {}\n});\n```\n\n### [.asyncHelper](index.js#L93)\n\nRegister an async helper.\n\n**Params**\n\n* `name` **{String}**: Helper name.\n* `fn` **{Function}**: Helper function\n\n**Example**\n\n```js\napp.asyncHelper('upper', function(str, next) {\n  next(null, str.toUpperCase());\n});\n```\n\n### [.asyncHelpers](index.js#L117)\n\nRegister multiple async template helpers.\n\n**Params**\n\n* `helpers` **{Object|Array}**: Object, array of objects, or glob patterns.\n\n**Example**\n\n```js\napp.asyncHelpers({\n  foo: function() {},\n  bar: function() {},\n  baz: function() {}\n});\n```\n\n### [.getHelper](index.js#L137)\n\nGet a previously registered helper.\n\n**Params**\n\n* `name` **{String}**: Helper name\n* `returns` **{Function}**: Returns the registered helper function.\n\n**Example**\n\n```js\nvar fn = app.getHelper('foo');\n```\n\n### [.getAsyncHelper](index.js#L154)\n\nGet a previously registered async helper.\n\n**Params**\n\n* `name` **{String}**: Helper name\n* `returns` **{Function}**: Returns the registered helper function.\n\n**Example**\n\n```js\nvar fn = app.getAsyncHelper('foo');\n```\n\n### [.hasHelper](index.js#L173)\n\nReturn true if sync helper `name` is registered.\n\n**Params**\n\n* `name` **{String}**: sync helper name\n* `returns` **{Boolean}**: Returns true if the sync helper is registered\n\n**Example**\n\n```js\nif (app.hasHelper('foo')) {\n  // do stuff\n}\n```\n\n### [.hasAsyncHelper](index.js#L191)\n\nReturn true if async helper `name` is registered.\n\n**Params**\n\n* `name` **{String}**: Async helper name\n* `returns` **{Boolean}**: Returns true if the async helper is registered\n\n**Example**\n\n```js\nif (app.hasAsyncHelper('foo')) {\n  // do stuff\n}\n```\n\n### [.helperGroup](index.js#L214)\n\nRegister a namespaced helper group.\n\n**Params**\n\n* `helpers` **{Object|Array}**: Object, array of objects, or glob patterns.\n\n**Example**\n\n```js\n// markdown-utils\napp.helperGroup('mdu', {\n  foo: function() {},\n  bar: function() {},\n});\n\n// Usage:\n// <%= mdu.foo() %>\n// <%= mdu.bar() %>\n```\n\n## History\n\n### v1.0.0\n\n* 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).\n\n### v0.2.0\n\n* 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.\n\n## About\n\n### Related projects\n\n* [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.\")\n* [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.\")\n* [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.\")\n* [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\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(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.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning 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:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 20, 2017._","_attachments":{},"homepage":"https://github.com/node-base/base-helpers","bugs":{"url":"https://github.com/node-base/base-helpers/issues"},"license":"MIT"}