useful-handlebars-helpers
Version:
More than 150 Handlebars helpers in 17 categories. Works in browsers and in Node.js.
1,932 lines (1,311 loc) • 64.7 kB
Markdown
# handlebars-helpers
<!-- {% raw %} -->
> Tons of awesome helpers for Handlebars
This library is used for templates in [Wirechunk](https://wirechunk.com).
## Browsers are supported
Though this is a fork of [helpers/handlebars-helpers](https://github.com/helpers/handlebars-helpers), this package
only has helpers that work both in Node.js and in browsers.
See how to [use handlebars-helpers in the browser](https://github.com/doowb/handlebars-helpers-browserify-example).
## Usage
Install this library:
```
npm install useful-handlebars-helpers
```
The main file (`index.js`) exports groups of helpers. See it for a list of all the groups.
Import the groups you want and register each as a helper:
```js
import handlebars from 'handlebars';
import { array, collection, math, number } from 'useful-handlebars-helpers';
[array, collection, math, number].forEach(
(helper) => {
Handlebars.registerHelper(helper);
},
);
```
You need to have Handlebars as a dependency yourself: it is declared as a peer dependency here.
Also, if you use syntax highlighting when rendering Markdown to HTML with the `helper-markdown` module, you
need to have highlight.js as a dependency yourself; it too is a peer dependency here.
## Helper categories
Currently **150 helpers** in **17 categories**:
* **[array](#array)** ([code](lib/array.js) | [unit tests](test/array.js))
* **[code](#code)** ([code](lib/code.js) | [unit tests](test/code.js))
* **[collection](#collection)** ([code](lib/collection.js) | [unit tests](test/collection.js))
* **[comparison](#comparison)** ([code](lib/comparison.js) | [unit tests](test/comparison.js))
* **[date](#date)** ([code](lib/date.js) | [unit tests](test/date.js))
* **[html](#html)** ([code](lib/html.js) | [unit tests](test/html.js))
* **[i18n](#internationalization)** ([code](lib/i18n.js) | [unit tests](test/i18n.js))
* **[inflection](#inflection)** ([code](lib/inflection.js) | [unit tests](test/inflection.js))
* **[markdown](#markdown)** ([code](lib/markdown.js) | [unit tests](test/markdown.js))
* **[math](#math)** ([code](lib/math.js) | [unit tests](test/math.js))
* **[misc](#misc)** ([code](lib/misc.js) | [unit tests](test/misc.js))
* **[number](#number)** ([code](lib/number.js) | [unit tests](test/number.js))
* **[object](#object)** ([code](lib/object.js) | [unit tests](test/object.js))
* **[path](#path)** ([code](lib/path.js) | [unit tests](test/path.js))
* **[regex](#regex)** ([code](lib/regex.js) | [unit tests](test/regex.js))
* **[string](#string)** ([code](lib/string.js) | [unit tests](test/string.js))
* **[url](#url)** ([code](lib/url.js) | [unit tests](test/url.js))
## All helpers
### Array helpers
Visit the: [code](lib/array.js) | [unit tests](test/array.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+array)
* **[after](#after)** ([code](lib/array.js) | [tests](test/array.js))
* **[eachIndex](#eachindex)** ([code](lib/array.js) | [tests](test/array.js))
* **[filter](#filter)** ([code](lib/array.js) | [tests](test/array.js))
* **[first](#first)** ([code](lib/array.js) | [tests](test/array.js))
* **[forEach](#foreach)** ([code](lib/array.js) | [tests](test/array.js))
* **[hasLength](#haslength)** ([code](lib/array.js) | [tests](test/array.js))
* **[inArray](#inarray)** ([code](lib/array.js) | [tests](test/array.js))
* **[isArray](#isarray)** ([code](lib/array.js) | [tests](test/array.js))
* **[itemAt](#itemat)** ([code](lib/array.js) | [tests](test/array.js))
* **[join](#join)** ([code](lib/array.js) | [tests](test/array.js))
* **[last](#last)** ([code](lib/array.js) | [tests](test/array.js))
* **[length](#length)** ([code](lib/array.js) | [tests](test/array.js))
* **[map](#map)** ([code](lib/array.js) | [tests](test/array.js))
* **[pluck](#pluck)** ([code](lib/array.js) | [tests](test/array.js))
* **[reverse](#reverse)** ([code](lib/array.js) | [tests](test/array.js))
* **[some](#some)** ([code](lib/array.js) | [tests](test/array.js))
* **[sort](#sort)** ([code](lib/array.js) | [tests](test/array.js))
* **[sortBy](#sortby)** ([code](lib/array.js) | [tests](test/array.js))
* **[toArray](#toarray)** ([code](lib/array.js) | [tests](test/array.js))
* **[withAfter](#withafter)** ([code](lib/array.js) | [tests](test/array.js))
* **[withFirst](#withfirst)** ([code](lib/array.js) | [tests](test/array.js))
* **[withGroup](#withgroup)** ([code](lib/array.js) | [tests](test/array.js))
* **[withLast](#withlast)** ([code](lib/array.js) | [tests](test/array.js))
* **[withSort](#withsort)** ([code](lib/array.js) | [tests](test/array.js))
* **[union](#union)** ([code](lib/array.js) | [tests](test/array.js))
* **[unique](#unique)** ([code](lib/array.js) | [tests](test/array.js))
* **[uniqueBy](#uniqueby)** ([code](lib/array.js) | [tests](test/array.js))
### Code helpers
Visit the: [code](lib/code.js) | [unit tests](test/code.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+code)
* **[gist](#gist)** ([code](lib/code.js) | [tests](test/code.js))
* **[jsfiddle](#jsfiddle)** ([code](lib/code.js) | [tests](test/code.js))
### Collection helpers
Visit the: [code](lib/collection.js) | [unit tests](test/collection.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+collection)
* **[isEmpty](#isempty)** ([code](lib/collection.js) | [tests](test/collection.js))
* **[iterate](#iterate)** ([code](lib/collection.js) | [tests](test/collection.js))
### Comparison helpers
Visit the: [code](lib/comparison.js) | [unit tests](test/comparison.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+comparison)
* **[and](#and)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[compare](#compare)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[contains](#contains)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[default](#default)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[eq](#eq)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[gt](#gt)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[gte](#gte)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[has](#has)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[isTruthy](#istruthy)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[ifEven](#ifeven)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[ifNth](#ifnth)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[ifOdd](#ifodd)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[is](#is)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[isnt](#isnt)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[lt](#lt)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[lte](#lte)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[neither](#neither)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[not](#not)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[or](#or)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[unlessEq](#unlesseq)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[unlessGt](#unlessgt)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[unlessLt](#unlesslt)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[unlessGteq](#unlessgteq)** ([code](lib/comparison.js) | [tests](test/comparison.js))
* **[unlessLteq](#unlesslteq)** ([code](lib/comparison.js) | [tests](test/comparison.js))
### Date helpers
Visit the: [code](lib/date.js) | [unit tests](test/date.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+date)
* **[year](#year)** ([code](lib/date.js) | [tests](test/date.js))
### HTML helpers
Visit the: [code](lib/html.js) | [unit tests](test/html.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+html)
* **[attr](#attr)** ([code](lib/html.js) | [tests](test/html.js))
* **[css](#css)** ([code](lib/html.js) | [tests](test/html.js))
* **[js](#js)** ([code](lib/html.js) | [tests](test/html.js))
* **[sanitize](#sanitize)** ([code](lib/html.js) | [tests](test/html.js))
* **[ul](#ul)** ([code](lib/html.js) | [tests](test/html.js))
* **[ol](#ol)** ([code](lib/html.js) | [tests](test/html.js))
* **[thumbnailImage](#thumbnailimage)** ([code](lib/html.js) | [tests](test/html.js))
### Internationalization helpers
Visit the: [code](lib/i18n.js) | [unit tests](test/i18n.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+i18n)
* **[i18n](#i18n)** ([code](lib/i18n.js) | [tests](test/i18n.js))
### Inflection helpers
Visit the: [code](lib/inflection.js) | [unit tests](test/inflection.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+inflection)
* **[inflect](#inflect)** ([code](lib/inflection.js) | [tests](test/inflection.js))
* **[ordinalize](#ordinalize)** ([code](lib/inflection.js) | [tests](test/inflection.js))
### Markdown helpers
Visit the: [code](lib/markdown.js) | [unit tests](test/markdown.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+markdown)
* **[markdownToHTML](#markdowntohtml)** ([code](lib/markdown.js) | [tests](test/markdown.js))
### Math helpers
Visit the: [code](lib/math.js) | [unit tests](test/math.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+math)
* **[abs](#abs)** ([code](lib/math.js) | [no tests])
* **[add](#add)** ([code](lib/math.js) | [tests](test/math.js))
* **[avg](#avg)** ([code](lib/math.js) | [no tests])
* **[ceil](#ceil)** ([code](lib/math.js) | [tests](test/math.js))
* **[divide](#divide)** ([code](lib/math.js) | [tests](test/math.js))
* **[floor](#floor)** ([code](lib/math.js) | [tests](test/math.js))
* **[multiply](#multiply)** ([code](lib/math.js) | [tests](test/math.js))
* **[random](#random)** ([code](lib/math.js) | [tests](test/math.js))
* **[remainder](#remainder)** ([code](lib/math.js) | [tests](test/math.js))
* **[round](#round)** ([code](lib/math.js) | [tests](test/math.js))
* **[subtract](#subtract)** ([code](lib/math.js) | [tests](test/math.js))
* **[sum](#sum)** ([code](lib/math.js) | [tests](test/math.js))
### Misc helpers
Visit the: [code](lib/misc.js) | [unit tests](test/misc.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+misc)
* **[option](#option)** ([code](lib/misc.js) | [tests](test/misc.js))
* **[noop](#noop)** ([code](lib/misc.js) | [tests](test/misc.js))
* **[typeOf](#typeof)** ([code](lib/misc.js) | [no tests])
* **[withHash](#withhash)** ([code](lib/misc.js) | [tests](test/misc.js))
### Number helpers
Visit the: [code](lib/number.js) | [unit tests](test/number.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+number)
* **[bytes](#bytes)** ([code](lib/number.js) | [tests](test/number.js))
* **[addCommas](#addcommas)** ([code](lib/number.js) | [tests](test/number.js))
* **[phoneNumber](#phonenumber)** ([code](lib/number.js) | [tests](test/number.js))
* **[toAbbr](#toabbr)** ([code](lib/number.js) | [tests](test/number.js))
* **[toExponential](#toexponential)** ([code](lib/number.js) | [tests](test/number.js))
* **[toFixed](#tofixed)** ([code](lib/number.js) | [tests](test/number.js))
* **[toFloat](#tofloat)** ([code](lib/number.js) | [tests](test/number.js))
* **[toInt](#toint)** ([code](lib/number.js) | [tests](test/number.js))
* **[toPrecision](#toprecision)** ([code](lib/number.js) | [tests](test/number.js))
### Object helpers
Visit the: [code](lib/object.js) | [unit tests](test/object.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+object)
* **[extend](#extend)** ([code](lib/object.js) | [tests](test/object.js))
* **[forIn](#forIn)** ([code](lib/object.js) | [tests](test/object.js))
* **[forOwn](#forOwn)** ([code](lib/object.js) | [tests](test/object.js))
* **[toPath](#toPath)** ([code](lib/object.js) | [tests](test/object.js))
* **[get](#get)** ([code](lib/object.js) | [tests](test/object.js))
* **[getObject](#getObject)** ([code](lib/object.js) | [tests](test/object.js))
* **[hasOwn](#hasOwn)** ([code](lib/object.js) | [tests](test/object.js))
* **[isObject](#isobject)** ([code](lib/object.js) | [tests](test/object.js))
* **[JSONparse](#jsonparse)** ([code](lib/object.js) | [tests](test/object.js))
* **[JSONstringify](#jsonstringify)** ([code](lib/object.js) | [tests](test/object.js))
* **[merge](#merge)** ([code](lib/object.js) | [tests](test/object.js))
* **[pick](#pick)** ([code](lib/object.js) | [tests](test/object.js))
### Path helpers
Visit the: [code](lib/path.js) | [unit tests](test/path.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+path)
* **[dirname](#dirname)** ([code](lib/path.js) | [tests](test/path.js))
* **[relative](#relative)** ([code](lib/path.js) | [tests](test/path.js))
* **[basename](#basename)** ([code](lib/path.js) | [tests](test/path.js))
* **[stem](#stem)** ([code](lib/path.js) | [tests](test/path.js))
* **[extname](#extname)** ([code](lib/path.js) | [tests](test/path.js))
* **[segments](#segments)** ([code](lib/path.js) | [tests](test/path.js))
### Regex helpers
Visit the: [code](lib/regex.js) | [unit tests](test/regex.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+regex)
* **[toRegex](#toRegex)** ([code](lib/regex.js) | [no tests])
* **[test](#test)** ([code](lib/regex.js) | [no tests])
### String helpers
Visit the: [code](lib/string.js) | [unit tests](test/string.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+string)
* **[append](#append)** ([code](lib/string.js) | [no tests])
* **[camelcase](#camelcase)** ([code](lib/string.js) | [tests](test/string.js))
* **[capitalize](#capitalize)** ([code](lib/string.js) | [tests](test/string.js))
* **[capitalizeAll](#capitalizeAll)** ([code](lib/string.js) | [tests](test/string.js))
* **[center](#center)** ([code](lib/string.js) | [tests](test/string.js))
* **[chop](#chop)** ([code](lib/string.js) | [tests](test/string.js))
* **[dashcase](#dashcase)** ([code](lib/string.js) | [tests](test/string.js))
* **[dotcase](#dotcase)** ([code](lib/string.js) | [tests](test/string.js))
* **[ellipsis](#ellipsis)** ([code](lib/string.js) | [tests](test/string.js))
* **[hyphenate](#hyphenate)** ([code](lib/string.js) | [tests](test/string.js))
* **[isString](#isString)** ([code](lib/string.js) | [tests](test/string.js))
* **[lowercase](#lowercase)** ([code](lib/string.js) | [tests](test/string.js))
* **[occurrences](#occurrences)** ([code](lib/string.js) | [tests](test/string.js))
* **[pascalcase](#pascalcase)** ([code](lib/string.js) | [tests](test/string.js))
* **[pathcase](#pathcase)** ([code](lib/string.js) | [tests](test/string.js))
* **[plusify](#plusify)** ([code](lib/string.js) | [tests](test/string.js))
* **[prepend](#prepend)** ([code](lib/string.js) | [no tests])
* **[raw](#raw)** ([code](lib/string.js) | [no tests])
* **[remove](#remove)** ([code](lib/string.js) | [no tests])
* **[removeFirst](#removeFirst)** ([code](lib/string.js) | [no tests])
* **[replace](#replace)** ([code](lib/string.js) | [tests](test/string.js))
* **[replaceFirst](#replaceFirst)** ([code](lib/string.js) | [no tests])
* **[sentence](#sentence)** ([code](lib/string.js) | [tests](test/string.js))
* **[snakecase](#snakecase)** ([code](lib/string.js) | [tests](test/string.js))
* **[split](#split)** ([code](lib/string.js) | [tests](test/string.js))
* **[startsWith](#startsWith)** ([code](lib/string.js) | [tests](test/string.js))
* **[titleize](#titleize)** ([code](lib/string.js) | [tests](test/string.js))
* **[trim](#trim)** ([code](lib/string.js) | [tests](test/string.js))
* **[trimLeft](#trimleft)** ([code](lib/string.js) | [no tests])
* **[trimRight](#trimright)** ([code](lib/string.js) | [no tests])
* **[truncate](#truncate)** ([code](lib/string.js) | [tests](test/string.js))
* **[truncateWords](#truncatewords)** ([code](lib/string.js) | [no tests])
* **[uppercase](#uppercase)** ([code](lib/string.js) | [tests](test/string.js))
### URL helpers
Visit the: [code](lib/url.js) | [unit tests](test/url.js) | [issues](https://github.com/wirechunk/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+url)
* **[decodeURIComponent](#decodeuricomponent)** ([code](lib/url.js) | [tests](test/url.js))
* **[encodeURIComponent](#encodeuricomponent)** ([code](lib/url.js) | [tests](test/url.js))
* **[urlResolve](#urlresolve)** ([code](lib/url.js) | [tests](test/url.js))
* **[urlParse](#urlparse)** ([code](lib/url.js) | [tests](test/url.js))
* **[stripQuerystring](#stripquerystring)** ([code](lib/url.js) | [tests](test/url.js))
***
## array
### after
Returns all of the items in an array, or characters in a string, after the specified index.
**Params**
* `array` **{Array|String}**: Collection
* `n` **{Number}**: Starting index (number of items to exclude)
* `returns` **{Array|String}**: Array or string excluding `n` items.
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'] -->
{{after array 1}}
<!-- results in: '["c"]' -->
<!-- str: "abcd" -->
{{after str 2}}
<!-- results in: 'cd' -->
```
### eachIndex
**Params**
* `array` **{Array}**
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'] -->
{{#eachIndex array}}
{{item}} is {{index}}
{{/eachIndex}}
```
### filter
Returns an array with the given array's elements filtered for elements that equal a specified value
or, if a hash argument with a "property" key is provided, for elements that have the specified
property equal to a specified value.
**Params**
* `array` **{Array}**
* `value` **{any}**
* `options` **{Object}**
* `returns` **{Array}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'a', 'c'] -->
{{filter array "a"}}
<!-- results in: ['a', 'a'] -->
<!-- array: [{ x: 'a' }, { x: 'b' }, { x: 'a' }, { x: 'c' }] -->
{{filter array "a" property="x"}}
<!-- results in: [{ x: 'a'}, { x: 'a' }] -->
```
### first
Returns the first item, or first `n` items of an array.
**Params**
* `array` **{Array}**
* `n` **{Number}**: Number of items to return, starting at `0`.
* `returns` **{Array}**
**Example**
```handlebars
{{first "['a', 'b', 'c', 'd', 'e']" 2}}
<!-- results in: '["a", "b"]' -->
```
### forEach
Iterates over each item in an array and exposes the current item in the array as context to the inner block. In addition to the current array item, the helper exposes the following variables to the inner block:
* `index`
* `total`
* `isFirst`
* `isLast`
Also, `@index` is exposed as a private variable, and additional
private variables may be defined as hash arguments.
**Params**
* `array` **{Array}**
* `returns` **{String}**
**Example**
```handlebars
<!-- accounts = [
{'name': 'John', 'email': 'john@example.com'},
{'name': 'Malcolm', 'email': 'malcolm@example.com'},
{'name': 'David', 'email': 'david@example.com'}
] -->
{{#forEach accounts}}
<a href="mailto:{{ email }}" title="Send an email to {{ name }}">
{{ name }}
</a>{{#unless isLast}}, {{/unless}}
{{/forEach}}
```
### inArray
Block helper that renders the block if an array has the given `value`. Optionally specify an inverse block to render when the array does not have the given value.
**Params**
* `array` **{Array}**
* `value` **{any}**
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'] -->
{{#inArray array "d"}}
foo
{{else}}
bar
{{/inArray}}
<!-- results in: 'bar' -->
```
### isArray
Returns true if `value` is an es5 array.
**Params**
* `value` **{any}**: The value to test.
* `returns` **{Boolean}**
**Example**
```handlebars
{{isArray "abc"}}
<!-- results in: false -->
<!-- array: [1, 2, 3] -->
{{isArray array}}
<!-- results in: true -->
```
### itemAt
Returns the item from `array` at index `idx`.
**Params**
* `array` **{Array}**
* `idx` **{Number}**
* `returns` **{any}** `value`
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'] -->
{{itemAt array 1}}
<!-- results in: 'b' -->
```
### join
Join all elements of array into a string, optionally using a given separator.
**Params**
* `array` **{Array}**
* `separator` **{String}**: The separator to use. Defaults to `,`.
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'] -->
{{join array}}
<!-- results in: 'a, b, c' -->
{{join array '-'}}
<!-- results in: 'a-b-c' -->
```
### hasLength
Returns true if the the length of the given `value` is equal
to the given `length`. Can be used as a block or inline helper.
**Params**
* `value` **{Array|String}**
* `length` **{Number}**
* `options` **{Object}**
* `returns` **{String}**
### last
Returns the last item, or last `n` items of an array or string. Opposite of [first](#first).
**Params**
* `value` **{Array|String}**: Array or string.
* `n` **{Number}**: Number of items to return from the end of the array.
* `returns` **{Array}**
**Example**
```handlebars
<!-- var value = ['a', 'b', 'c', 'd', 'e'] -->
{{last value}}
<!-- results in: ['e'] -->
{{last value 2}}
<!-- results in: ['d', 'e'] -->
{{last value 3}}
<!-- results in: ['c', 'd', 'e'] -->
```
### length
Returns the length of the given string or array.
**Params**
* `value` **{Array|Object|String}**
* `returns` **{Number}**: The length of the value.
**Example**
```handlebars
{{length '["a", "b", "c"]'}}
<!-- results in: 3 -->
<!-- results in: myArray = ['a', 'b', 'c', 'd', 'e']; -->
{{length myArray}}
<!-- results in: 5 -->
<!-- results in: myObject = {'a': 'a', 'b': 'b'}; -->
{{length myObject}}
<!-- results in: 2 -->
```
### map
Returns a new array, created by calling `function` on each element of the given `array`. For example,
**Params**
* `array` **{Array}**
* `fn` **{Function}**
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'], and "double" is a
fictitious function that duplicates letters -->
{{map array double}}
<!-- results in: '["aa", "bb", "cc"]' -->
```
### pluck
Map over the given object or array or objects and create an array of values from the given `prop`. Dot-notation may be used (as a string) to get nested properties.
**Params**
* `collection` **{Array|Object}**
* `prop` **{Function}**
* `returns` **{String}**
**Example**
```handlebars
// {{pluck items "data.title"}}
<!-- results in: '["aa", "bb", "cc"]' -->
```
### reverse
Reverse the elements in an array, or the characters in a string.
**Params**
* `value` **{Array|String}**
* `returns` **{Array|String}**: Returns the reversed string or array.
**Example**
```handlebars
<!-- value: 'abcd' -->
{{reverse value}}
<!-- results in: 'dcba' -->
<!-- value: ['a', 'b', 'c', 'd'] -->
{{reverse value}}
<!-- results in: ['d', 'c', 'b', 'a'] -->
```
### some
Block helper that returns the block if the callback returns true for some value in the given array.
**Params**
* `array` **{Array}**
* `iter` **{Function}**: Iteratee
* **{Options}**: Handlebars provided options object
* `returns` **{String}**
**Example**
```handlebars
<!-- array: [1, 'b', 3] -->
{{#some array isString}}
Render me if the array has a string.
{{else}}
Render me if it doesn't.
{{/some}}
<!-- results in: 'Render me if the array has a string.' -->
```
### sort
Sort the given `array`. If an array of objects is passed, you may optionally pass a `key` to sort on as the second argument. You may alternatively pass a sorting function as the second argument.
**Params**
* `array` **{Array}**: the array to sort.
* `key` **{String|Function}**: The object key to sort by, or sorting function.
**Example**
```handlebars
<!-- array: ['b', 'a', 'c'] -->
{{sort array}}
<!-- results in: '["a", "b", "c"]' -->
```
### sortBy
Sort an `array`. If an array of objects is passed, you may optionally pass a `key` to sort on as the second argument. You may alternatively pass a sorting function as the second argument.
**Params**
* `array` **{Array}**: the array to sort.
* `props` **{String|Function}**: One or more properties to sort by, or sorting functions to use.
**Example**
```handlebars
<!-- array: [{a: 'zzz'}, {a: 'aaa'}] -->
{{sortBy array "a"}}
<!-- results in: '[{"a":"aaa"}, {"a":"zzz"}]' -->
```
### toArray
Combine the given values into an array.
**Params**
* `values` **{...any}**
* `returns` **{Array}**
**Example**
```handlebars
{{toArray "foo"}}
<!-- results in: [ "foo" ] -->
{{toArray "foo" "bar"}}
<!-- results in: [ "foo", "bar" ] -->
```
### withAfter
Use the items in the array _after_ the specified index as context inside a block.
**Params**
* `array` **{Array}**
* `idx` **{Number}**
* `options` **{Object}**
* `returns` **{Array}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c', 'd', 'e'] -->
{{#withAfter array 3}}
{{this}}
{{/withAfter}}
<!-- results in: "de" -->
```
### withFirst
Use the first item in a collection inside a handlebars block expression. Opposite of [withLast](#withLast).
**Params**
* `array` **{Array}**
* `idx` **{Number}**
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'] -->
{{#withFirst array}}
{{this}}
{{/withFirst}}
<!-- results in: 'a' -->
```
### withGroup
Block helper that groups array elements by given group `size`.
**Params**
* `array` **{Array}**: The array to iterate over
* `size` **{Number}**: The desired length of each array "group"
* `options` **{Object}**: Handlebars options
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a','b','c','d','e','f','g','h'] -->
{{#withGroup array 4}}
{{#each this}}
{{.}}
{{each}}
<br>
{{/withGroup}}
<!-- results in: -->
<!-- 'a','b','c','d'<br> -->
<!-- 'e','f','g','h'<br> -->
```
### withLast
Use the last item or `n` items in an array as context inside a block. Opposite of [withFirst](#withFirst).
**Params**
* `array` **{Array}**
* `idx` **{Number}**: The starting index.
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['a', 'b', 'c'] -->
{{#withLast array}}
{{this}}
{{/withLast}}
<!-- results in: 'c' -->
```
### withSort
Block helper that sorts a collection and exposes the sorted collection as context inside the block.
**Params**
* `array` **{Array}**
* `prop` **{String}**
* `options` **{Object}**: Specify `reverse="true"` to reverse the array.
* `returns` **{String}**
**Example**
```handlebars
<!-- array: ['b', 'a', 'c'] -->
{{#withSort array}}{{this}}{{/withSort}}
<!-- results in: 'abc' -->
```
### union
Returns an array of all of the unique values from the two given arrays.
Elements are compared using [SameValueZero](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness),
which is similar to strict equality except that NaN is considered equal to NaN.
**Params**
* `array1` **{Array}**
* `array2` **{Array}**
* `returns` **{Array}**
**Example**
```handlebars
<!-- array1: ['a', 'a', 'c', 'b'], array2: ['a', 'b', 'e'] -->
{{#each (unique array)}}{{.}}{{/each}}
<!-- results in: 'acbe' -->
```
### unique
Returns an array with all duplicate values removed.
Elements are compared using [SameValueZero](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness),
which is similar to strict equality except that NaN is considered equal to NaN.
**Params**
* `array` **{Array}**
* `options` **{Object}**
* `returns` **{Array}**
**Example**
```handlebars
<!-- array: ['a', 'a', 'c', 'b', 'e', 'e'] -->
{{#each (unique array)}}{{.}}{{/each}}
<!-- results in: 'acbe' -->
```
### uniqueBy
Returns an array with all duplicate values removed using the property or comparison function specified.
**Params**
* `array` **{Array}**
* `prop` **{String|Function}**: The property or comparison function by which to determine uniqueness.
* `returns` **{Array}**
**Example**
```handlebars
<!-- array: [{a: 'zz', id: 1}, {a: 'aa', id: 2}, {a: 'zz', id: 3}] -->
{{uniqueBy array "a"}}
<!-- results in: [{ a: "zz", id: 1}, { a: "aa", id: 2 }] -->
```
## code
### gist
Embed a GitHub Gist using only the id of the Gist
**Params**
* `id` **{String}**
* `returns` **{String}**
**Example**
```handlebars
{{gist "12345"}}
```
### jsfiddle
Generate the HTML for a jsFiddle link with the given `params`
**Params**
* `params` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
{{jsfiddle id="0dfk10ks" tabs="true"}}
```
## collection
### isEmpty
Inline, subexpression, or block helper that returns true (or the block) if the given collection is empty, or false (or the inverse block, if supplied) if the colleciton is not empty.
**Params**
* `collection` **{Object}**
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
<!-- array: [] -->
{{#isEmpty array}}AAA{{else}}BBB{{/isEmpty}}
<!-- results in: 'AAA' -->
<!-- array: [] -->
{{isEmpty array}}
<!-- results in: true -->
```
### iterate
Block helper that iterates over an array or object. If
an array is given, `.forEach` is called, or if an object
is given, `.forOwn` is called, otherwise the inverse block
is returned.
**Params**
* `collection` **{Object|Array}**: The collection to iterate over
* `options` **{Object}**
* `returns` **{String}**
## comparison
### and
Helper that renders the block if **both** of the given values are truthy. If an inverse block is specified it will be rendered when falsy. Works as a block helper, inline helper or subexpression.
**Params**
* `a` **{any}**
* `b` **{any}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**
**Example**
```handlebars
<!-- {great: true, magnificent: true} -->
{{#and great magnificent}}A{{else}}B{{/and}}
<!-- results in: 'A' -->
```
### compare
Render a block when a comparison of the first and third
arguments returns true. The second argument is
the [arithmetic operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Arithmetic_Operators) to use. You may also
optionally specify an inverse block to render when falsy.
**Params**
* `a` **{}**
* `operator` **{}**: The operator to use. Operators must be enclosed in quotes: `">"`, `"="`, `"<="`, and so on.
* `b` **{}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or if specified the inverse block is rendered if falsey.
### contains
Block helper that renders the block if `collection` has the given `value`, using strict equality (`===`) for comparison, otherwise the inverse block is rendered (if specified). If a `startIndex` is specified and is negative, it is used as the offset from the end of the collection.
**Params**
* `collection` **{Array|Object|String}**: The collection to iterate over.
* `value` **{any}**: The value to check for.
* `[startIndex=0]` **{Number}**: Optionally define the starting index.
* `options` **{Object}**: Handlebars provided options object.
**Example**
```handlebars
<!-- array = ['a', 'b', 'c'] -->
{{#contains array "d"}}
This will not be rendered.
{{else}}
This will be rendered.
{{/contains}}
```
### default
Returns the first value that is not undefined, otherwise the "default" value is returned.
**Params**
* `value` **{any}**
* `defaultValue` **{any}**
* `returns` **{String}**
### eq
Block helper that renders a block if `a` is **equal to** `b`.
If an inverse block is specified it will be rendered when falsy.
You may optionally use the `compare=""` hash argument for the
second value.
**Params**
* `a` **{String}**
* `b` **{String}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### gt
Block helper that renders a block if `a` is **greater than** `b`.
If an inverse block is specified it will be rendered when falsy.
You may optionally use the `compare=""` hash argument for the
second value.
**Params**
* `a` **{String}**
* `b` **{String}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### gte
Block helper that renders a block if `a` is **greater than or equal to** `b`.
If an inverse block is specified it will be rendered when falsy.
You may optionally use the `compare=""` hash argument for the
second value.
**Params**
* `a` **{String}**
* `b` **{String}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### has
Block helper that renders a block if `value` has `pattern`.
If an inverse block is specified it will be rendered when falsy.
**Params**
* `val` **{any}**: The value to check.
* `pattern` **{any}**: The pattern to check for.
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**
### isTruthy
Returns true if the given `value` is truthy.
**Params**
* `val` **{any}**
* `options` **{Options}**
* `returns` **{Boolean}**
### ifEven
Return true if the given value is an even number.
**Params**
* `number` **{Number}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
**Example**
```handlebars
{{#ifEven value}}
render A
{{else}}
render B
{{/ifEven}}
```
### ifNth
Conditionally renders a block if the remainder is zero when
`a` operand is divided by `b`. If an inverse block is specified
it will be rendered when the remainder is **not zero**.
**Params**
* **{}**: {Number}
* **{}**: {Number}
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### ifOdd
Block helper that renders a block if `value` is **an odd number**. If an inverse block is specified it will be rendered when falsy.
**Params**
* `value` **{Object}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
**Example**
```handlebars
{{#ifOdd value}}
render A
{{else}}
render B
{{/ifOdd}}
```
### is
Block helper that renders a block if `a` is **equal to** `b`.
If an inverse block is specified it will be rendered when falsy.
Similar to [eq](#eq) but does not do strict equality.
**Params**
* `a` **{any}**
* `b` **{any}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**
### isnt
Block helper that renders a block if `a` is **not equal to** `b`.
If an inverse block is specified it will be rendered when falsy.
Similar to [unlessEq](#unlesseq) but does not use strict equality for
comparisons.
**Params**
* `a` **{String}**
* `b` **{String}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**
### lt
Block helper that renders a block if `a` is **less than** `b`.
If an inverse block is specified it will be rendered when falsy.
You may optionally use the `compare=""` hash argument for the
second value.
**Params**
* `context` **{Object}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### lte
Block helper that renders a block if `a` is **less than or equal to** `b`.
If an inverse block is specified it will be rendered when falsy.
You may optionally use the `compare=""` hash argument for the
second value.
**Params**
* `a` **{Sring}**
* `b` **{Sring}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### neither
Block helper that renders a block if **neither of** the given values
are truthy. If an inverse block is specified it will be rendered
when falsy.
**Params**
* `a` **{any}**
* `b` **{any}**
* `options` **{}**: Handlebars options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### not
Returns true if `val` is falsey. Works as a block or inline helper.
**Params**
* `val` **{String}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**
### or
Block helper that renders a block if **any of** the given values is truthy. If an inverse block is specified it will be rendered when falsy.
**Params**
* `arguments` **{...any}**: Variable number of arguments
* `options` **{Object}**: Handlebars options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
**Example**
```handlebars
{{#or a b c}}
If any value is true this will be rendered.
{{/or}}
```
### unlessEq
Block helper that always renders the inverse block **unless `a` is
is equal to `b`**.
**Params**
* `a` **{String}**
* `b` **{String}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Inverse block by default, or block if falsey.
### unlessGt
Block helper that always renders the inverse block **unless `a` is
is greater than `b`**.
**Params**
* `a` **{Object}**: The default value
* `b` **{Object}**: The value to compare
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Inverse block by default, or block if falsey.
### unlessLt
Block helper that always renders the inverse block **unless `a` is
is less than `b`**.
**Params**
* `a` **{Object}**: The default value
* `b` **{Object}**: The value to compare
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### unlessGteq
Block helper that always renders the inverse block **unless `a` is
is greater than or equal to `b`**.
**Params**
* `a` **{any}**
* `b` **{any}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
### unlessLteq
Block helper that always renders the inverse block **unless `a` is
is less than or equal to `b`**.
**Params**
* `a` **{any}**
* `b` **{any}**
* `options` **{Object}**: Handlebars provided options object
* `returns` **{String}**: Block, or inverse block if specified and falsey.
## date
### year
Get the current year.
**Example**
```handlebars
{{year}}
<!-- 2017 -->
```
## html
### attr
Stringify attributes on the options `hash`.
**Params**
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
<!-- value = 'bar' -->
<div{{attr foo=value}}></div>
<!-- results in: <div foo="bar"></div>
```
### css
Add an array of `<link>` tags. Automatically resolves relative paths to `options.assets` if passed on the context.
**Params**
* `list` **{String|Array}**: One or more stylesheet urls.
* `returns` **{String}**
**Example**
```handlebars
<!-- {stylesheets: ['foo.css', 'bar.css']} -->
{{css stylesheets}}
<!-- results in: -->
<!-- <link type="text/css" rel="stylesheet" href="foo.css"> -->
<!-- <link type="text/css" rel="stylesheet" href="bar.css"> -->
```
### js
Generate one or more `<script></script>` tags with paths/urls to javascript or coffeescript files.
**Params**
* `context` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
{{js scripts}}
```
### sanitize
Strip HTML tags from a string, so that only the text nodes are preserved.
**Params**
* `str` **{String}**: The string of HTML to sanitize.
* `returns` **{String}**
**Example**
```handlebars
{{sanitize "<span>foo</span>"}}
<!-- results in: 'foo' -->
```
### ul
Block helper for creating unordered lists (`<ul></ul>`)
**Params**
* `context` **{Object}**
* `options` **{Object}**
* `returns` **{String}**
### ol
Block helper for creating ordered lists (`<ol></ol>`)
**Params**
* `context` **{Object}**
* `options` **{Object}**
* `returns` **{String}**
### thumbnailImage
Returns a `<figure>` with a thumbnail linked to a full picture
**Params**
* `context` **{Object}**: Object with values/attributes to add to the generated elements:
* `context.alt` **{String}**
* `context.src` **{String}**
* `context.width` **{Number}**
* `context.height` **{Number}**
* `returns` **{String}**: HTML `<figure>` element with image and optional caption/link.
## internationalization
### i18n
i18n helper. See [button-i18n](https://github.com/assemble/buttons)
for a working example.
**Params**
* `key` **{String}**
* `options` **{Object}**
* `returns` **{String}**
## inflection
### inflect
Returns either the `singular` or `plural` inflection of a word based on the given `count`.
**Params**
* `count` **{Number}**
* `singular` **{String}**: The singular form
* `plural` **{String}**: The plural form
* `includeCount` **{String}**
* `returns` **{String}**
**Example**
```handlebars
{{inflect 0 "string" "strings"}}
<!-- "strings" -->
{{inflect 1 "string" "strings"}}
<!-- "string" -->
{{inflect 1 "string" "strings" true}}
<!-- "1 string" -->
{{inflect 2 "string" "strings"}}
<!-- "strings" -->
{{inflect 2 "string" "strings" true}}
<!-- "2 strings" -->
```
### ordinalize
Returns an ordinalized number as a string.
**Params**
* `val` **{String}**: The value to ordinalize.
* `returns` **{String}**: The ordinalized number
**Example**
```handlebars
{{ordinalize 1}}
<!-- '1st' -->
{{ordinalize 21}}
<!-- '21st' -->
{{ordinalize 29}}
<!-- '29th' -->
{{ordinalize 22}}
<!-- '22nd' -->
```
## markdown
### markdownToHTML
Block helper that converts a string of inline markdown to HTML.
**Params**
* `context` **{Object}**
* `options` **{Object}**
* `returns` **{String}**
**Example**
```handlebars
{{#markdownToHTML}}
# Foo
> some quote
{{/markdownToHTML}}
<!-- results in:
<h1>Foo</h1>
<blockquote>
<p>some quote</p>
</blockquote>
-->
```
## math
### abs
Return the magnitude of `a`.
**Params**
* `a` **{Number}**
* `returns` **{Number}**
### add
Return the sum of `a` plus `b`.
**Params**
* `a` **{Number}**
* `b` **{Number}**
* `returns` **{Number}**
### avg
Returns the average of all numbers in the given array.
**Params**
* `array` **{Array}**: Array of numbers to add up.
* `returns` **{Number}**
**Example**
```handlebars
{{avg "[1, 2, 3, 4, 5]"}}
<!-- results in: '3' -->
```
### ceil
Get the `Math.ceil()` of the given value.
**Params**
* `value` **{Number}**
* `returns` **{Number}**
### divide
Divide `a` by `b`
**Params**
* `a` **{Number}**: numerator
* `b` **{Number}**: denominator
### floor
Get the `Math.floor()` of the given value.
**Params**
* `value` **{Number}**
* `returns` **{Number}**
### multiply
Return the product of `a` times `b`.
**Params**
* `a` **{Number}**: factor
* `b` **{Number}**: multiplier
* `returns` **{Number}**
### random
Generate a random number between two values
**Params**
* `min` **{Number}**
* `max` **{Number}**
* `returns` **{Number}**
### remainder
Get the remainder of dividing `a` by `b`.
**Params**
* `a` **{Number}**
* `b` **{Number}**
* `returns` **{Number}**
**Example**
```handlebars
{{remainder 7 5}}
<!-- results in: 2 -->
```
### round
Round the given number.
**Params**
* `number` **{Number}**
* `returns` **{Number}**
### subtract
Return the product of `a` minus `b`.
**Params**
* `a` **{Number}**
* `b` **{Number}**
* `returns` **{Number}**
### sum
Returns the sum of all numbers in the given array.
**Params**
* `array` **{Array}**: Array of numbers to add up.
* `returns` **{Number}**
**Example**
```handlebars
{{sum "[1, 2, 3, 4, 5]"}}
<!-- results in: '15' -->
```
## misc
### option
Return the given value of `prop` from `this.options`.
**Params**
* `prop` **{String}**
* `returns` **{any}**
**Example**
```handlebars
<!-- context = {options: {a: {b: {c: 'ddd'}}}} -->
{{option "a.b.c"}}
<!-- results => `ddd` -->
```
### noop
Block helper that renders the block without taking any arguments.
**Params**
* `options` **{Object}**
* `returns` **{String}**
### typeOf
Get the native type of the given `value`
**Params**
* `value` **{any}**
* `returns` **{String}**: Returns the type of value.
**Example**
```handlebars
{{typeOf 1}}
//=> 'number'
{{typeOf "1"}}
//=> 'string'
{{typeOf "foo"}}
//=> 'string'
```
### withHash
Block helper that builds the context for the block
from the options hash.
**Params**
* `options` **{Object}**: Handlebars provided options object.
## number
### bytes
Format a number to it's equivalent in bytes. If a string is passed, it's length will be formatted and returned.
**Examples:**
* `'foo' => 3 B`
* `13661855 => 13.66 MB`
* `825399 => 825.39 kB`
* `1396 => 1.4 kB`
**Params**
* `number` **{Number|String}**
* `returns` **{String}**
### addCommas
Add commas to numbers
**Params**
* `num` **{Number}**
* `returns` **{Number}**
### phoneNumber
Convert a string or number to a formatted phone number.
**Params**
* `num` **{Number|String}**: The phone number to format, e.g. `8005551212`
* `returns` **{Number}**: Formatted phone number: `(800) 555-1212`
### toAbbr
Abbreviate numbers to the given number of `precision`. This is for
general numbers, not size in bytes.
**Params**
* `number` **{Number}**
* `precision` **{Number}**
* `returns` **{String}**
### toExponential
Returns a string representing the given number in exponential notation.
**Params**
* `number` **{Number}**
* `fractionDigits` **{Number}**: Optional. An integer specifying the number of digits to use after the decimal point. Defaults to as many digits as necessary to specify the number.
* `returns` **{Number}**
**Example**
```handlebars
{{toExponential number digits}};
```
### toFixed
Formats the given number using fixed-point notation.
**Params**
* `number` **{Number}**
* `digits` **{Number}**: (Optional) The number of digits to appear after the decimal point; this may be a value between 0 and 20. If this argument is omitted, it is treated as 0.
* `returns` **{String}**: A string representing the given number using fixed-point notation.
**Example**
```handlebars
{{toFixed "1.1234" 2}}
//=> '1.12'
```
### toFloat
**Params**
* `number` **{Number}**
* `returns` **{Number}**
### toInt
**Params**
* `number` **{Number}**
* `returns` **{Number}**
### toPrecision
Returns a string representing the `Number` object to the specified precision.
**Params**
* `number` **{Number}**
* `precision` **{Number}**: (Optional) An integer specifying the number of significant digits. If precison is not between 1 and 100 (inclusive), it will be coerced to `0`.
* `returns` **{String}**: A string representing a Number object in fixed-point or exponential notation rounded to precision significant digits.
**Example**
```handlebars
{{toPrecision "1.1234" 2}}
//=> '1.1'
```
## object
### extend
Extend the context with the properties of other objects.
A shallow merge is performed to avoid mutating the context.
**Params**
* `objects` **{Object}**: One or more objects to extend.
* `returns` **{Object}**
### forIn
Block helper that iterates over the properties of
an object, exposing each key and value on the context.
**Params**
* `context` **{Object}**
* `options` **{Object}**
* `returns` **{String}**
### forOwn
Block helper that iterates over the **own** properties of
an object, exposing each key and value on the context.
**Params**
* `obj` **{Object}**: The object to iterate over.
* `options` **{Object}**
* `returns` **{String}**
### toPath
Take arguments and, if they are string or number, convert them to a dot-delineated object property path.
**Params**
* `prop` **{String|Number}**: The property segments to assemble (can be multiple).
* `returns` **{String}**
### get
Use property paths (`a.b.c`) to get a value or nested value from
the context. Works as a regular helper or block helper.
**Params**
* `prop` **{String}**: The property to get, optionally using dot notation for nested properties.
* `context` **{Object}**: The context object
* `options` **{Object}**: The handlebars options object, if used as a block helper.
* `returns` **{String}**
### getObject
Use property paths (`a.b.c`) to get an object from
the context. Differs from the `get` helper in that this
helper will return the actual object, including the
given property key. Also, this helper does not work as a
block helper.
**Params**
* `prop` **{String}**: The property to get, optionally using dot notation for nested properties.
* `context` **{Object}**: The context object
* `returns` **{String}**
### hasOwn
Return true if `key` is an own, enumerable property of the given `context` object.
**Params**
* `key` **{String}**
* `context` **{Object}**: The context object.
* `returns` **{Boolean}**
**Example**
```handlebars
{{hasOwn context key}}
```
### isObject
Return true if `value` is an object.
**Params**
* `value` **{String}**
* `returns` **{Boolean}**
**Example**
```handlebars
{{isObject "foo"}}
//=> false
```
### JSONparse
Parses the given string using `JSON.parse`.
**Params**
* `string` **{String}**: The string to parse
**Example**
```handlebars
<!-- string: '{"foo": "bar"}' -->
{{JSONparse string}}
<!-- results in: { foo: 'bar' } -->
```
### JSONstringify
Stringify an object using `JSON.stringify`.
**Params**
* `obj` **{Object}**: Object to stringify
* `returns` **{String}**
**Example**
```handlebars
<!-- object: { foo: 'bar' } -->
{{JSONstringify object}}
<!-- results in: '{"foo": "bar"}' -->
```
### merge
Deeply merge the properties of the given `objects` with the
context object.
**Params**
* `object` **{Object}**: The target object. Pass an empty object to shallow clone.
* `objects` **{Object}**
* `returns` **{Object}**
### pick
Pick p