handlebars-utils    

> Utils for handlebars helpers. Externalized from handlebars, to allow helpers to use the utils without having to depend on handlebars itself.

Follow this project's author, Jon Schlinkert, for updates on this project and others.

- Install
- Usage
- API
* .isBlock
* .fn
* .inverse
* .value
* .isOptions
* .isUndefined
* .isApp
* .options
* .context
* .isObject
* .isEmpty
* .result
* .identity
* .isString
* .arrayify
* .tryParse
- About
* Related projects
* Contributing
* Building docs
* Running tests
* Author
* License

_(TOC generated by verb using markdown-toc)_

Install

Install with npm:

``sh
$ npm install --save handlebars-utils
`

Usage

`js
var utils = require('handlebars-utils');
`

API

$3

Returns true if a helper is a block helper.

Params

* options {Object}: Helper options object
* returns {Boolean}

Example

`js
Handlebars.registerHelper('example', function(options) {
if (utils.isBlock(options)) {
// do something if this is a block helper
} else {
// do something else if this is a not block helper
}
});
`

$3

Returns the given value or renders the block if it's a block helper.

Params

* val {any}
* options {Object}
* context {Object}
* returns {String}: Either returns the value, or renders the block.

Example

`js
Handlebars.registerHelper('example', function(val, locals, options) {
return utils.fn(val, locals, options);
});
`

$3

Returns the given value or renders the inverse block if it's a block helper.

Params

* val {any}
* options {Object}
* context {Object}
* returns {String}: Either returns the value, or renders the inverse block.

Example

`js
Handlebars.registerHelper('example', function(val, locals, options) {
return utils.inverse(val, locals, options);
});
`

$3

Gets the return value for a helper, by either rendering the block or inverse block if it's a block helper, or returning the given value (when truthy) or an empty string (when falsey) if it's a non-block expression.

Params

* val {any}
* options {Object}
* context {Object}
* returns {String}

Example

`js
Handlebars.registerHelper('example', function(val, locals, options) {
return utils.value(val, locals, options);
});
`

$3

Returns true if the given value is a handlebar options object.

Params

* val {Object}
* returns {Boolean}

Example

`js
Handlebars.registerHelper('example', function(val, locals, options) {
if (utils.isOptions(locals)) {
options = locals;
locals = {};
}
// do stuff
});
`

$3

Returns true if the given value is undefined or is a handlebars options hash (which means that a value was not passed by the user).

Params

* value {any}
* returns {Boolean}

Example

`js
Handlebars.registerHelper('example', function(val, options) {
if (utils.isUndefined(val)) {
return '';
}
// do stuff
});
`

$3

Returns true if an app propery is on the context, which means the context was created by assemble, templates, verb, or any other library that follows this convention.

Params

* value {any}
* returns {Boolean}

Example

`js
Handlebars.registerHelper('example', function(val, options) {
var context = options.hash;
if (utils.isApp(this)) {
context = Object.assign({}, this.context, context);
}
// do stuff
});
`

$3

Creates an options object from the context, locals and options.
Handlebars' options.hash is merged onto the options, and if the context
is created by templates, this.options will be merged onto the
options as well.

Params

* context {Object}
* locals {Object}: Options or locals
* options {Object}
* returns {Boolean}

$3

Get the context to use for rendering.

Params

* thisArg {Object}: Optional invocation context this
* returns {Object}

$3

Returns true if the given value is an object.

Params

* val {Object}
* returns {Boolean}

Example

`js
console.log(utils.isObject(null));
//=> false
console.log(utils.isObject([]));
//=> false
console.log(utils.isObject(function() {}));
//=> false
console.log(utils.isObject({}));
//=> true
`

$3

Returns true if the given value is "empty".

Params

* value {any}
* returns {Boolean}

Example

`js
console.log(utils.isEmpty(0));
//=> false
console.log(utils.isEmpty(''));
//=> true
console.log(utils.isEmpty([]));
//=> true
console.log(utils.isEmpty({}));
//=> true
`

$3

Returns the given value. If the value is a function it will be called with the current context, otherwise the value is returned.

Params

* val {any}
* returns {any}

Example

`js
console.log(utils.result('foo'));
//=> 'foo'
console.log(utils.result(function() {
return 'foo';
}));
//=> 'foo'
`

$3

Returns the given value as-is, unchanged.

Params

* val {any}
* returns {any}

Example

`js
console.log(utils.result('foo'));
//=> 'foo'
console.log(utils.result(function() {
return 'foo';
}));
//=> [function]
`

$3

Return true if val is a non-empty string.

Params

* val {any}: The value to check
* returns {Boolean}

$3

Cast the given val to an array.

Params

* val {any}
* returns {Array}

Example

`js
console.log(utils.arrayify(''));
//=> []
console.log(utils.arrayify('foo'));
//=> ['foo']
console.log(utils.arrayify(['foo']));
//=> ['foo']
`

$3

Try to parse the given string as JSON. Fails
gracefully and always returns an object if the value cannot be parsed.

Params

* string {String}
* returns {Object}

About

$3

You might also be interested in these projects:

* assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
* handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… 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

$3

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

$3

_(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:

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

$3

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:

`sh
$ npm install && npm test
``

$3

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

$3

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

*

_This file was generated by verb-generate-readme, v0.6.0, on September 04, 2017._