Handlebars Kit
This is a fork of the handlebars-helpers created by Jon Schlinkert.
Motivations for forking
- To minimise the number of dependencies, reducing the maintenance effort
- To remove potentially risky helpers (such as any that interact with the file system)
- To increase the number of test cases and resulting test coverage
You might also be interested in template-helpers.
Install
Install with npm:
$ npm i handlebars-kit
Install with yarn:
$ yarn add handlebars-kit
Usage
The main export returns a function that needs to be called to expose the object of helpers.
Get all helpers
const helpers = require('handlebars-kit')();
//=> returns object with all (130+) helpers
Get a specific helper collection
Helper collections are exposed as getters, so only the helpers you want will be required and loaded.
const helpers = require('handlebars-kit');
const math = helpers.math();
//=> only the `math` helpers
const helpers = require('handlebars-kit');
const array = helpers.array();
//=> only the `collections` helpers
Get multiple helpers collections
Helper collections are exposed as getters, so only the helpers you want will be required and loaded.
const helpers = require('handlebars-kit')(['math', 'string']);
//=> only the `math` and `string` helpers
Optionally pass your own handlebars
const handlebars = require('handlebars');
const helpers = require('handlebars-kit')({
handlebars: handlebars
});
// or for a specific collection
const math = helpers.math({
handlebars: handlebars
});
Helpers
Categories
- array (code | unit tests)
- collection (code | unit tests)
- comparison (code | unit tests)
- date (code | unit tests)
- html (code | unit tests)
- i18n (code | unit tests)
- inflection (code | unit tests)
- math (code | unit tests)
- misc (code | unit tests)
- number (code | unit tests)
- object (code | unit tests)
- path (code | unit tests)
- regex (code | unit tests)
- string (code | unit tests)
- url (code | unit tests)
All helpers
array helpers
Visit the: code | unit tests
- after (code | tests)
- arrayify (code | tests)
- before (code | tests)
- eachIndex (code | tests)
- filter (code | tests)
- first (code | tests)
- forEach (code | tests)
- inArray (code | tests)
- isArray (code | tests)
- itemAt (code | tests)
- join (code | tests)
- equalsLength (code | [no tests])
- last (code | tests)
- length (code | tests)
- lengthEqual (code | tests)
- map (code | tests)
- pluck (code | tests)
- reverse (code | tests)
- some (code | tests)
- sort (code | tests)
- sortBy (code | tests)
- withAfter (code | tests)
- withBefore (code | tests)
- withFirst (code | tests)
- withGroup (code | tests)
- withLast (code | tests)
- withSort (code | tests)
- unique (code | tests)
collection helpers
Visit the: code | unit tests
comparison helpers
Visit the: code | unit tests
- and (code | tests)
- compare (code | tests)
- contains (code | tests)
- default (code | tests)
- eq (code | tests)
- gt (code | tests)
- gte (code | tests)
- has (code | tests)
- isFalsey (code | tests)
- isTruthy (code | tests)
- ifEven (code | tests)
- ifNth (code | tests)
- ifOdd (code | tests)
- is (code | tests)
- isnt (code | tests)
- lt (code | tests)
- lte (code | tests)
- neither (code | tests)
- not (code | [no tests])
- or (code | tests)
- unlessEq (code | tests)
- unlessGt (code | tests)
- unlessLt (code | tests)
- unlessGteq (code | tests)
- unlessLteq (code | tests)
date helpers
Visit the: code | unit tests
- year (code | tests)
- date (code | tests)
- moment (code | [no tests])
- formatDate (code | tests)
- niceDate (code | tests)
- getTime (code | tests)
html helpers
Visit the: code | unit tests
- attr (code | tests)
- css (code | tests)
- ul (code | tests)
- ol (code | tests)
- thumbnailImage (code | tests)
i18n helpers
Visit the: code | unit tests
inflection helpers
Visit the: code | unit tests
math helpers
Visit the: code | unit tests
- abs (code | tests)
- add (code | tests)
- avg (code | [no tests])
- ceil (code | tests)
- divide (code | tests)
- floor (code | tests)
- minus (code | tests)
- modulo (code | tests)
- multiply (code | tests)
- plus (code | tests)
- random (code | tests)
- remainder (code | tests)
- round (code | tests)
- subtract (code | tests)
- sum (code | tests)
- times (code | tests)
misc helpers
Visit the: code | unit tests
number helpers
Visit the: code | unit tests
- fileSize (code | [no tests])
- bytes (code | tests)
- addCommas (code | tests)
- phoneNumber (code | tests)
- toAbbr (code | tests)
- toExponential (code | tests)
- toFixed (code | tests)
- toFloat (code | tests)
- toInt (code | tests)
- toPrecision (code | tests)
object helpers
Visit the: code | unit tests
- extend (code | tests)
- forOwn (code | tests)
- toPath (code | tests)
- get (code | tests)
- getObject (code | tests)
- hasOwn (code | tests)
- isObject (code | tests)
- JSONparse (code | tests)
- JSONstringify (code | tests)
- merge (code | tests)
- parseJSON (code | [no tests])
- pick (code | tests)
- stringify (code | tests)
path helpers
Visit the: code | unit tests
- dirname (code | tests)
- basename (code | tests)
- stem (code | tests)
- extname (code | tests)
- segments (code | tests)
- linkToUNC (code | tests)
regex helpers
Visit the: code | unit tests
string helpers
Visit the: code | unit tests
- append (code | tests)
- camelcase (code | tests)
- capitalize (code | tests)
- capitalizeAll (code | tests)
- center (code | tests)
- chop (code | tests)
- dashcase (code | tests)
- dotcase (code | tests)
- downcase (code | [no tests])
- ellipsis (code | tests)
- hyphenate (code | tests)
- isString (code | tests)
- lowercase (code | tests)
- occurrences (code | tests)
- pascalcase (code | tests)
- pathcase (code | tests)
- plusify (code | tests)
- prepend (code | tests)
- raw (code | [no tests])
- remove (code | tests)
- removeFirst (code | tests)
- replace (code | tests)
- replaceFirst (code | tests)
- reverse (code | tests)
- sentence (code | tests)
- snakecase (code | tests)
- split (code | tests)
- startsWith (code | tests)
- titleize (code | tests)
- trim (code | tests)
- trimLeft (code | tests)
- trimRight (code | tests)
- truncate (code | tests)
- truncateWords (code | tests)
- upcase (code | [no tests])
- uppercase (code | tests)
url helpers
Visit the: code | unit tests
- encodeURI (code | tests)
- escape (code | tests)
- decodeURI (code | tests)
- url_encode (code | [no tests])
- url_decode (code | [no tests])
- urlResolve (code | tests)
- urlParse (code | tests)
- stripQuerystring (code | tests)
- stripProtocol (code | [no tests])
array
{{after}}
Returns all of the items in an array after the specified index. Opposite of before.
Params
-
array
{Array}: Collection -
n
{Number}: Starting index (number of items to exclude) -
returns
{Array}: Array exludingn
items.
Example
{{arrayify}}
Cast the given value
to an array.
Params
-
value
{any} -
returns
{Array}
Example
{{before}}
Return all of the items in the collection before the specified count. Opposite of after.
Params
-
array
{Array} -
n
{Number} -
returns
{Array}: Array excluding items after the given number.
Example
{{eachIndex}}
Params
-
array
{Array} -
options
{Object} -
returns
{String}
Example
{{filter}}
Block helper that filters the given array and renders the block for values that evaluate to true
, otherwise the inverse block is returned.
Params
-
array
{Array} -
value
{any} -
options
{Object} -
returns
{String}
Example
{{first}}
Returns the first item, or first n
items of an array.
Params
-
array
{Array} -
n
{Number}: Number of items to return, starting at0
. -
returns
{Array}
Example
{{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
{{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
{{isArray}}
Returns true if value
is an es5 array.
Params
-
value
{any}: The value to test. -
returns
{Boolean}
Example
{{itemAt}}
Returns the item from array
at index idx
.
Params
-
array
{Array} -
idx
{Number} -
returns
{any}value
Example
{{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
{{equalsLength}}
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.
Params
-
value
{Array|String}: Array or string. -
n
{Number}: Number of items to return from the end of the array. -
returns
{Array}
Example
{{length}}
Returns the length of the given string or array.
Params
-
value
{Array|Object|String} -
returns
{Number}: The length of the value.
Example
{{lengthEqual}}
Alias for equalsLength
{{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
{{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
{{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
{{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
{{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
{{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
{{withAfter}}
Use the items in the array after the specified index as context inside a block. Opposite of withBefore.
Params
-
array
{Array} -
idx
{Number} -
options
{Object} -
returns
{Array}
Example
{{withBefore}}
Use the items in the array before the specified index as context inside a block. Opposite of withAfter.
Params
-
array
{Array} -
idx
{Number} -
options
{Object} -
returns
{Array}
Example
{{withFirst}}
Use the first item in a collection inside a handlebars block expression. Opposite of withLast.
Params
-
array
{Array} -
idx
{Number} -
options
{Object} -
returns
{String}
Example
{{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
{{withLast}}
Use the last item or n
items in an array as context inside a block. Opposite of withFirst.
Params
-
array
{Array} -
idx
{Number}: The starting index. -
options
{Object} -
returns
{String}
Example
{{withSort}}
Block helper that sorts a collection and exposes the sorted collection as context inside the block.
Params
-
array
{Array} -
prop
{String} -
options
{Object}: Specifyreverse="true"
to reverse the array. -
returns
{String}
Example
{{unique}}
Block helper that return an array with all duplicate values removed. Best used along with a each helper.
Params
-
array
{Array} -
options
{Object} -
returns
{Array}
Example
code
{{embed}}
Embed code from an external file as preformatted text.
Params
-
filepath
{String}: filepath to the file to embed. -
language
{String}: Optionally specify the language to use for syntax highlighting. -
returns
{String}
Example
{{gist}}
Embed a GitHub Gist using only the id of the Gist
Params
-
id
{String} -
returns
{String}
Example
{{jsfiddle}}
Generate the HTML for a jsFiddle link with the given params
Params
-
params
{Object} -
returns
{String}
Example
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
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
{{compare}}
Render a block when a comparison of the first and third arguments returns true. The second argument is the arithemetic operator 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
{{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}
{{isFalsey}}
Returns true if the given value
is falsey. Uses the falsey
library for comparisons. Please see that library for more information
or to report bugs with this helper.
Params
-
val
{any} -
options
{Options} -
returns
{Boolean}
{{isTruthy}}
Returns true if the given value
is truthy. Uses the falsey
library for comparisons. Please see that library for more information
or to report bugs with this helper.
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
{{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
{{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 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 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
{{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
{{moment}}
Use moment as a helper. See helper-date for more details.
html
{{attr}}
Stringify attributes on the options hash
.
Params
-
options
{Object} -
returns
{String}
Example
{{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
{{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.
i18n
{{i18n}}
i18n helper. See button-i18n 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
{{ordinalize}}
Returns an ordinalized number as a string.
Params
-
val
{String}: The value to ordinalize. -
returns
{String}: The ordinalized number
Example
logging
{{md}}
Read a markdown file from the file system and inject its contents after converting it to HTML.
Params
-
context
{Object} -
options
{Object} -
returns
{String}
Example
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
{{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}
{{minus}}
Return the difference of a
minus b
.
Params
-
a
{Number} -
b
{Number}
{{modulo}}
Get the remainder of a division operation.
Params
-
a
{Number} -
b
{Number} -
returns
{Number}
{{multiply}}
Return the product of a
times b
.
Params
-
a
{Number}: factor -
b
{Number}: multiplier -
returns
{Number}
{{plus}}
Add a
by b
.
Params
-
a
{Number}: factor -
b
{Number}: multiplier
{{random}}
Generate a random number between two values
Params
-
min
{Number} -
max
{Number} -
returns
{String}
{{remainder}}
Get the remainder when a
is divided by b
.
Params
-
a
{Number}: a -
b
{Number}: b
{{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
{{times}}
Multiply number a
by number b
.
Params
-
a
{Number}: factor -
b
{Number}: multiplier -
returns
{Number}
misc
{{option}}
Return the given value of prop
from this.options
.
Params
-
prop
{String} -
returns
{any}
Example
{{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
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
{{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
{{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 to0
. -
returns
{String}: A string representing a Number object in fixed-point or exponential notation rounded to precision significant digits.
Example
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}
{{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
{{isObject}}
Return true if value
is an object.
Params
-
value
{String} -
returns
{Boolean}
Example
{{JSONparse}}
Parses the given string using JSON.parse
.
Params
-
string
{String}: The string to parse
Example
{{JSONstringify}}
Stringify an object using JSON.stringify
.
Params
-
obj
{Object}: Object to stringify -
returns
{String}
Example
{{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 properties from the context object.
Params
-
properties
{Array|String}: One or more properties to pick. -
context
{Object} -
options
{Object}: Handlebars options object. -
returns
{Object}: Returns an object with the picked values. If used as a block helper, the values are passed as context to the inner block. If no values are found, the context is passed to the inverse block.
path
{{dirname}}
Get the directory path segment from the given filepath
.
Params
-
ext
{String} -
returns
{String}
Example
{{basename}}
Get the file extension from the given filepath
.
Params
-
ext
{String} -
returns
{String}
Example
{{stem}}
Get the "stem" from the given filepath
.
Params
-
filepath
{String} -
returns
{String}
Example
{{extname}}
Get the file extension from the given filepath
.
Params
-
filepath
{String} -
returns
{String}
Example
{{segments}}
Get specific (joined) segments of a file path by passing a range of array indices.
Params
-
filepath
{String}: The file path to split into segments. -
returns
{String}: Returns a single, joined file path.
Example
regex
{{toRegex}}
Convert the given string to a regular expression.
Params
-
str
{String} -
returns
{RegExp}
Example
{{test}}
Returns true if the given str
matches the given regex. A regex can be passed on the context, or using the toRegex helper as a subexpression.
Params
-
str
{String} -
returns
{RegExp}
Example
string
{{append}}
Append the specified suffix
to the given string.
Params
-
str
{String} -
suffix
{String} -
returns
{String}
Example
{{camelcase}}
camelCase the characters in the given string
.
Params
-
string
{String}: The string to camelcase. -
returns
{String}
Example
{{capitalize}}
Capitalize the first word in a sentence.
Params
-
str
{String} -
returns
{String}
Example
{{capitalizeAll}}
Capitalize all words in a string.
Params
-
str
{String} -
returns
{String}
Example
{{center}}
Center a string using non-breaking spaces
Params
-
str
{String} -
spaces
{String} -
returns
{String}
{{chop}}
Like trim, but removes both extraneous whitespace and non-word characters from the beginning and end of a string.
Params
-
string
{String}: The string to chop. -
returns
{String}
Example
{{dashcase}}
dash-case the characters in string
. Replaces non-word characters and periods with hyphens.
Params
-
string
{String} -
returns
{String}
Example
{{dotcase}}
dot.case the characters in string
.
Params
-
string
{String} -
returns
{String}
Example
{{downcase}}
Lowercase all of the characters in the given string. Alias for lowercase.
Params
-
string
{String} -
returns
{String}
Example
{{ellipsis}}
Truncates a string to the specified length
, and appends it with an elipsis, …
.
Params
-
str
{String} -
length
{Number}: The desired length of the returned string. -
returns
{String}: The truncated string.
Example
{{hyphenate}}
Replace spaces in a string with hyphens.
Params
-
str
{String} -
returns
{String}
Example
{{isString}}
Return true if value
is a string.
Params
-
value
{String} -
returns
{Boolean}
Example
{{lowercase}}
Lowercase all characters in the given string.
Params
-
str
{String} -
returns
{String}
Example
{{occurrences}}
Return the number of occurrences of substring
within the given string
.
Params
-
str
{String} -
substring
{String} -
returns
{Number}: Number of occurrences
Example
{{pascalcase}}
PascalCase the characters in string
.
Params
-
string
{String} -
returns
{String}
Example
{{pathcase}}
path/case the characters in string
.
Params
-
string
{String} -
returns
{String}
Example
{{plusify}}
Replace spaces in the given string with pluses.
Params
-
str
{String}: The input string -
returns
{String}: Input string with spaces replaced by plus signs
Example
{{prepend}}
Prepends the given string
with the specified prefix
.
Params
-
str
{String} -
prefix
{String} -
returns
{String}
Example
{{raw}}
Render a block without processing mustache templates inside the block.
Params
-
options
{Object} -
returns
{String}
Example
{{remove}}
Remove all occurrences of substring
from the given str
.
Params
-
str
{String} -
substring
{String} -
returns
{String}
Example
{{removeFirst}}
Remove the first occurrence of substring
from the given str
.
Params
-
str
{String} -
substring
{String} -
returns
{String}
Example
{{replace}}
Replace all occurrences of substring a
with substring b
.
Params
-
str
{String} -
a
{String} -
b
{String} -
returns
{String}
Example
{{replaceFirst}}
Replace the first occurrence of substring a
with substring b
.
Params
-
str
{String} -
a
{String} -
b
{String} -
returns
{String}
Example
{{reverse}}
Reverse a string.
Params
-
str
{String} -
returns
{String}
Example
{{sentence}}
Sentence case the given string
Params
-
str
{String} -
returns
{String}
Example
{{snakecase}}
snake_case the characters in the given string
.
Params
-
string
{String} -
returns
{String}
Example
{{split}}
Split string
by the given character
.
Params
-
string
{String}: The string to split. -
returns
{String}character
: Default is an empty string.
Example
{{startsWith}}
Tests whether a string begins with the given prefix.
Params
-
prefix
{String} -
testString
{String} -
options
{String} -
returns
{String}
Example
{{titleize}}
Title case the given string.
Params
-
str
{String} -
returns
{String}
Example
{{trim}}
Removes extraneous whitespace from the beginning and end of a string.
Params
-
string
{String}: The string to trim. -
returns
{String}
Example
{{trimLeft}}
Removes extraneous whitespace from the beginning of a string.
Params
-
string
{String}: The string to trim. -
returns
{String}
Example
{{trimRight}}
Removes extraneous whitespace from the end of a string.
Params
-
string
{String}: The string to trim. -
returns
{String}
Example
{{truncate}}
Truncate a string to the specified length
. Also see ellipsis.
Params
-
str
{String} -
limit
{Number}: The desired length of the returned string. -
suffix
{String}: Optionally supply a string to use as a suffix to denote when the string has been truncated. Otherwise an ellipsis (…
) will be used. -
returns
{String}: The truncated string.
Example
{{truncateWords}}
Truncate a string to have the specified number of words. Also see truncate.
Params
-
str
{String} -
limit
{Number}: The desired length of the returned string. -
suffix
{String}: Optionally supply a string to use as a suffix to denote when the string has been truncated. -
returns
{String}: The truncated string.
Example
{{upcase}}
Uppercase all of the characters in the given string. Alias for uppercase.
Params
-
string
{String} -
returns
{String}
Example
{{uppercase}}
Uppercase all of the characters in the given string. If used as a block helper it will uppercase the entire block. This helper does not support inverse blocks.
Params
-
str
{String}: The string to uppercase -
options
{Object}: Handlebars options object -
returns
{String}
Example
url
{{encodeURI}}
Encodes a Uniform Resource Identifier (URI) component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character.
Params
-
str
{String}: The un-encoded string -
returns
{String}: The endcoded string
{{escape}}
Escape the given string by replacing characters with escape sequences. Useful for allowing the string to be used in a URL, etc.
Params
-
str
{String} -
returns
{String}: Escaped string.
{{decodeURI}}
Decode a Uniform Resource Identifier (URI) component.
Params
-
str
{String} -
returns
{String}
{{url_encode}}
Alias for encodeURI.
{{url_decode}}
Alias for decodeURI.
{{urlResolve}}
Take a base URL, and a href URL, and resolve them as a browser would for an anchor tag.
Params
-
base
{String} -
href
{String} -
returns
{String}
{{urlParse}}
Parses a url
string into an object.
Params
-
str
{String}: URL string -
returns
{String}: Returns stringified JSON
{{stripQuerystring}}
Strip the query string from the given url
.
Params
-
url
{String} -
returns
{String}: the url without the queryString
{{stripProtocol}}
Strip protocol from a url
. Useful for displaying media that may have an 'http' protocol on secure connections.
Params
-
str
{String} -
returns
{String}: the url with http protocol stripped
Example
Utils
The following utils are exposed on .utils
.
{{changecase}}
Change casing on the given string
, optionally passing a delimiter to use between words in the returned string.
Params
-
string
{String}: The string to change. -
returns
{String}
Example
{{random}}
Generate a random number
Params
-
min
{Number} -
max
{Number} -
returns
{Number}
License
Released under the MIT License.