More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate, Verb, Ghost, gulp-handlebars, grunt-handlebars, consolidate, or any node.js/Handlebars project.
You might also be interested in template-helpers.
Install with npm:
$ npm install --save handlebars-helpersInstall with yarn:
$ yarn add handlebars-helpersSee how to use handlebars-helpers in the browser.
The main export returns a function that needs to be called to expose the object of helpers.
Get all helpers
var helpers = require('handlebars-helpers')();
//=> returns object with all (130+) helpersGet a specific helper collection
Helper collections are exposed as getters, so only the helpers you want will be required and loaded.
var helpers = require('handlebars-helpers');
var math = helpers.math();
//=> only the `math` helpers
var helpers = require('handlebars-helpers');
var array = helpers.array();
//=> only the `collections` helpersGet multiple helpers collections
Helper collections are exposed as getters, so only the helpers you want will be required and loaded.
var helpers = require('handlebars-helpers')(['math', 'string']);
//=> only the `math` and `string` helpersOptionally pass your own handlebars
var handlebars = require('handlebars');
var helpers = require('handlebars-helpers')({
handlebars: handlebars
});
// or for a specific collection
var math = helpers.math({
handlebars: handlebars
});Currently 189 helpers in 20 categories:
- array (code | unit tests)
- code (code | unit tests)
- collection (code | unit tests)
- comparison (code | unit tests)
- date (code | unit tests)
- fs (code | unit tests)
- html (code | unit tests)
- i18n (code | unit tests)
- inflection (code | unit tests)
- logging (code | unit tests)
- markdown (code | unit tests)
- match (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)
Visit the: code | unit tests | issues)
- 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 | [no 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)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
- 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)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
- attr (code | tests)
- css (code | tests)
- js (code | tests)
- sanitize (code | tests)
- ul (code | tests)
- ol (code | tests)
- thumbnailImage (code | tests)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
- log (code | [no tests])
- ok (code | [no tests])
- success (code | [no tests])
- info (code | [no tests])
- warning (code | [no tests])
- warn (code | [no tests])
- error (code | [no tests])
- danger (code | [no tests])
- bold (code | [no tests])
- _debug (code | [no tests])
- _inspect (code | [no tests])
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
- abs (code | [no tests])
- add (code | tests)
- avg (code | [no tests])
- ceil (code | tests)
- divide (code | tests)
- floor (code | tests)
- minus (code | [no tests])
- modulo (code | [no tests])
- multiply (code | tests)
- plus (code | [no tests])
- random (code | tests)
- remainder (code | tests)
- round (code | tests)
- subtract (code | tests)
- sum (code | tests)
- times (code | [no tests])
Visit the: code | unit tests | issues)
- frame (code | [no tests])
- option (code | tests)
- noop (code | tests)
- typeOf (code | [no tests])
- withHash (code | tests)
Visit the: code | unit tests | issues)
- 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)
Visit the: code | unit tests | issues)
- extend (code | tests)
- forIn (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 | [no tests])
- merge (code | tests)
- parseJSON (code | [no tests])
- pick (code | tests)
- stringify (code | tests)
Visit the: code | unit tests | issues)
- absolute (code | tests)
- dirname (code | tests)
- relative (code | tests)
- basename (code | tests)
- stem (code | tests)
- extname (code | tests)
- resolve (code | [no tests])
- segments (code | tests)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
- append (code | [no 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 | [no tests])
- raw (code | [no tests])
- remove (code | [no tests])
- removeFirst (code | [no tests])
- replace (code | tests)
- replaceFirst (code | [no tests])
- reverse (code | tests)
- sentence (code | tests)
- snakecase (code | tests)
- split (code | tests)
- startsWith (code | tests)
- titleize (code | tests)
- trim (code | tests)
- trimLeft (code | [no tests])
- trimRight (code | [no tests])
- truncate (code | tests)
- truncateWords (code | [no tests])
- upcase (code | [no tests])
- uppercase (code | tests)
Visit the: code | unit tests | issues)
- encodeURI (code | tests)
- escape (code | [no 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])
Returns all of the items in an array after the specified index. Opposite of before.
Params
array{Array}: Collectionn{Number}: Starting index (number of items to exclude)returns{Array}: Array exludingnitems.
Example
Cast the given value to an array.
Params
value{any}returns{Array}
Example
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
Params
array{Array}options{Object}returns{String}
Example
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
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
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:
indextotalisFirstisLastAlso,@indexis exposed as a private variable, and additional private variables may be defined as hash arguments.
Params
array{Array}returns{String}
Example
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
Returns true if value is an es5 array.
Params
value{any}: The value to test.returns{Boolean}
Example
Returns the item from array at index idx.
Params
array{Array}idx{Number}returns{any}value
Example
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
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}
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
Returns the length of the given string or array.
Params
value{Array|Object|String}returns{Number}: The length of the value.
Example
Alias for equalsLength
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
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 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
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 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
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
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
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
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
Block helper that groups array elements by given group size.
Params
array{Array}: The array to iterate oversize{Number}: The desired length of each array "group"options{Object}: Handlebars optionsreturns{String}
Example
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
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
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
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
Embed a GitHub Gist using only the id of the Gist
Params
id{String}returns{String}
Example
Generate the HTML for a jsFiddle link with the given params
Params
params{Object}returns{String}
Example
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
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 overoptions{Object}returns{String}
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 objectreturns{String}
Example
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 objectreturns{String}: Block, or if specified the inverse block is rendered if falsey.
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
Returns the first value that is not undefined, otherwise the "default" value is returned.
Params
value{any}defaultValue{any}returns{String}
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}
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}
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}
Return true if the given value is an even number.
Params
number{Number}options{Object}: Handlebars provided options objectreturns{String}: Block, or inverse block if specified and falsey.
Example
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
Example
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 objectreturns{String}
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 objectreturns{String}
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
Returns true if val is falsey. Works as a block or inline helper.
Params
val{String}options{Object}: Handlebars provided options objectreturns{String}
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 argumentsoptions{Object}: Handlebars options objectreturns{String}: Block, or inverse block if specified and falsey.
Example
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 objectreturns{String}: Inverse block by default, or block if falsey.
Block helper that always renders the inverse block unless a is
is greater than b.
Params
a{Object}: The default valueb{Object}: The value to compareoptions{Object}: Handlebars provided options objectreturns{String}: Inverse block by default, or block if falsey.
Block helper that always renders the inverse block unless a is
is less than b.
Params
a{Object}: The default valueb{Object}: The value to compareoptions{Object}: Handlebars provided options objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
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 objectreturns{String}: Block, or inverse block if specified and falsey.
Get the current year.
Example
Use moment as a helper. See helper-date for more details.
Read a file from the file system. This is useful in composing "include"-style helpers using sub-expressions.
Params
filepath{String}returns{String}
Example
Return an array of files from the given directory.
Params
directory{String}returns{Array}
Stringify attributes on the options hash.
Params
options{Object}returns{String}
Example
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
Generate one or more <script></script> tags with paths/urls to javascript or coffeescript files.
Params
context{Object}returns{String}
Example
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
Block helper for creating unordered lists (<ul></ul>)
Params
context{Object}options{Object}returns{String}
Block helper for creating ordered lists (<ol></ol>)
Params
context{Object}options{Object}returns{String}
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 helper. See button-i18n for a working example.
Params
key{String}options{Object}returns{String}
Returns either the singular or plural inflection of a word based on the given count.
Params
count{Number}singular{String}: The singular formplural{String}: The plural formincludeCount{String}returns{String}
Example
Returns an ordinalized number as a string.
Params
val{String}: The value to ordinalize.returns{String}: The ordinalized number
Example
Block helper that converts a string of inline markdown to HTML.
Params
context{Object}options{Object}returns{String}
Example
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
Returns an array of strings that match the given glob pattern(s). Options may be passed on the options hash or locals.
Params
files{Array|String}patterns{Array|String}: One or more glob patterns.locals{Object}options{Object}returns{Array}: Array of matches
Example
Returns true if a filepath contains the given pattern. Options may be passed on the options hash or locals.
Params
filepath{String}pattern{String}options{Object}returns{Boolean}
Example
Return the magnitude of a.
Params
a{Number}returns{Number}
Return the sum of a plus b.
Params
a{Number}b{Number}returns{Number}
Returns the average of all numbers in the given array.
Params
array{Array}: Array of numbers to add up.returns{Number}
Example
Get the Math.ceil() of the given value.
Params
value{Number}returns{Number}
Divide a by b
Params
a{Number}: numeratorb{Number}: denominator
Get the Math.floor() of the given value.
Params
value{Number}returns{Number}
Return the difference of a minus b.
Params
a{Number}b{Number}
Get the remainder of a division operation.
Params
a{Number}b{Number}returns{Number}
Return the product of a times b.
Params
a{Number}: factorb{Number}: multiplierreturns{Number}
Add a by b.
Params
a{Number}: factorb{Number}: multiplier
Generate a random number between two values
Params
min{Number}max{Number}returns{String}
Get the remainder when a is divided by b.
Params
a{Number}: ab{Number}: b
Round the given number.
Params
number{Number}returns{Number}
Return the product of a minus b.
Params
a{Number}b{Number}returns{Number}
Returns the sum of all numbers in the given array.
Params
array{Array}: Array of numbers to add up.returns{Number}
Example
Multiply number a by number b.
Params
a{Number}: factorb{Number}: multiplierreturns{Number}
Return the given value of prop from this.options.
Params
prop{String}returns{any}
Example
Block helper that renders the block without taking any arguments.
Params
options{Object}returns{String}
Get the native type of the given value
Params
value{any}returns{String}: Returns the type of value.
Example
Block helper that builds the context for the block from the options hash.
Params
options{Object}: Handlebars provided options object.
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 B13661855 => 13.66 MB825399 => 825.39 kB1396 => 1.4 kB
Params
number{Number|String}returns{String}
Add commas to numbers
Params
num{Number}returns{Number}
Convert a string or number to a formatted phone number.
Params
num{Number|String}: The phone number to format, e.g.8005551212returns{Number}: Formatted phone number:(800) 555-1212
Abbreviate numbers to the given number of precision. This is for
general numbers, not size in bytes.
Params
number{Number}precision{Number}returns{String}
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
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
Params
number{Number}returns{Number}
Params
number{Number}returns{Number}
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
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}
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}
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}
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}
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 objectoptions{Object}: The handlebars options object, if used as a block helper.returns{String}
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 objectreturns{String}
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
Return true if value is an object.
Params
value{String}returns{Boolean}
Example
Parses the given string using JSON.parse.
Params
string{String}: The string to parse
Example
Stringify an object using JSON.stringify.
Params
obj{Object}: Object to stringifyreturns{String}
Example
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 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.
Get the directory path segment from the given filepath.
Params
ext{String}returns{String}
Example
Get the directory path segment from the given filepath.
Params
ext{String}returns{String}
Example
Get the relative filepath from a to b.
Params
a{String}b{String}returns{String}
Example
Get the file extension from the given filepath.
Params
ext{String}returns{String}
Example
Get the "stem" from the given filepath.
Params
filepath{String}returns{String}
Example
Get the file extension from the given filepath.
Params
filepath{String}returns{String}
Example
Resolve an absolute path from the given filepath.
Params
filepath{String}returns{String}
Example
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
Convert the given string to a regular expression.
Params
str{String}returns{RegExp}
Example
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
Append the specified suffix to the given string.
Params
str{String}suffix{String}returns{String}
Example
camelCase the characters in the given string.
Params
string{String}: The string to camelcase.returns{String}
Example
Capitalize the first word in a sentence.
Params
str{String}returns{String}
Example
Capitalize all words in a string.
Params
str{String}returns{String}
Example
Center a string using non-breaking spaces
Params
str{String}spaces{String}returns{String}
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
dash-case the characters in string. Replaces non-word characters and periods with hyphens.
Params
string{String}returns{String}
Example
dot.case the characters in string.
Params
string{String}returns{String}
Example
Lowercase all of the characters in the given string. Alias for lowercase.
Params
string{String}returns{String}
Example
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
Replace spaces in a string with hyphens.
Params
str{String}returns{String}
Example
Return true if value is a string.
Params
value{String}returns{Boolean}
Example
Lowercase all characters in the given string.
Params
str{String}returns{String}
Example
Return the number of occurrences of substring within the given string.
Params
str{String}substring{String}returns{Number}: Number of occurrences
Example
PascalCase the characters in string.
Params
string{String}returns{String}
Example
path/case the characters in string.
Params
string{String}returns{String}
Example
Replace spaces in the given string with pluses.
Params
str{String}: The input stringreturns{String}: Input string with spaces replaced by plus signs
Example
Prepends the given string with the specified prefix.
Params
str{String}prefix{String}returns{String}
Example
Render a block without processing mustache templates inside the block.
Params
options{Object}returns{String}
Example
Remove all occurrences of substring from the given str.
Params
str{String}substring{String}returns{String}
Example
Remove the first occurrence of substring from the given str.
Params
str{String}substring{String}returns{String}
Example
Replace all occurrences of substring a with substring b.
Params
str{String}a{String}b{String}returns{String}
Example
Replace the first occurrence of substring a with substring b.
Params
str{String}a{String}b{String}returns{String}
Example
Reverse a string.
Params
str{String}returns{String}
Example
Sentence case the given string
Params
str{String}returns{String}
Example
snake_case the characters in the given string.
Params
string{String}returns{String}
Example
Split string by the given character.
Params
string{String}: The string to split.returns{String}character: Default is an empty string.
Example
Tests whether a string begins with the given prefix.
Params
prefix{String}testString{String}options{String}returns{String}
Example
Title case the given string.
Params
str{String}returns{String}
Example
Removes extraneous whitespace from the beginning and end of a string.
Params
string{String}: The string to trim.returns{String}
Example
Removes extraneous whitespace from the beginning of a string.
Params
string{String}: The string to trim.returns{String}
Example
Removes extraneous whitespace from the end of a string.
Params
string{String}: The string to trim.returns{String}
Example
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
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
Uppercase all of the characters in the given string. Alias for uppercase.
Params
string{String}returns{String}
Example
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 uppercaseoptions{Object}: Handlebars options objectreturns{String}
Example
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 stringreturns{String}: The endcoded string
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.
Decode a Uniform Resource Identifier (URI) component.
Params
str{String}returns{String}
Alias for encodeURI.
Alias for decodeURI.
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}
Parses a url string into an object.
Params
str{String}: URL stringreturns{String}: Returns stringified JSON
Strip the query string from the given url.
Params
url{String}returns{String}: the url without the queryString
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
The following utils are exposed on .utils.
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
Generate a random number
Params
min{Number}max{Number}returns{Number}
v0.10.0 - 2017-11-17
changes
- adds
uniqueto array helpers - updates
csshelper to ensure that path.join() is not called on an absolute URL.
v0.9.0 - 2017-07-03
changes
- all unit tests now use assert instead of should
- remove
fileSizehelper in favor of newbyteshelper, which does the same thing, but returnsBinstead ofbyteorbytes. - JSONParse helper is no longer a block helper. It now returns an object, which can be used as a subexpression to achieve the same behavior as before.
- adds better error handling for path helpers, since node.js errors are terrible. We have a better way to handle errors that will be implemented in a near future release.
- adds inline helper support to
isEmpty, so it can now be used as an inline or block helper - adds
rawhelper - adds regex helpers
- adds inline helper support to most of the comparison helpers, so they can now be used as inline or block helpers
- adds
pluckhelper to array helpers - adds
prependandappendhelpers to string helpers - adds
isTruthyandisFalseycomparison helpers - adds
escapeandurl_encodeandurl_decodeURL helpers - adds
attrhelper to html helpers - adds
yearhelper to date helpers - adds
typeOfandframehelpers to misc helpers - adds
abs,minus,modulo,plus,timesto math helpers - moves
ellipsishelper fromhtmlhelpers to string helpers - moves
truncatehelper fromhtmlhelpers to string helpers - moves
reversehelper fromstringhelpers to array helpers - differentiate
eqandishelpers so thateqis strict equality andisis not - removes
mmhelper, usematchinstead
v0.8.4 - 2017-07-03
changes
- removes strlen helper in favor of fixing the length helper
v0.8.3 - 2017-07-03
changes
- adds strlen helper
- adds itemAt helper
- clean up code comments for array helpers
v0.8.2 - 2017-03-30
changes
- documentation updates
- fixes md helper to use sync by default
v0.8.1 - 2017-03-30
changes
- fixes sorting in withSort helper. see helpers#245
- adds toPath helper
- handle null inputs in number helpers
- adds stripProtocol helper
v0.8.0 - 2017-01-25
changes
- handle string arguments in list helpers
- adds JSONParse helper as an alias for parseJSON
v0.7.6 - 2017-01-08
changes
- fixes markdown helpers. see helpers#226
- documentation improvements and other minor fixes
v0.7.0 - 2016-07-16
changes
- The or helper can now take a variable number of arguments
v0.6.0 - 2016-05-13
changes
- the main export is now a function that takes a name or array of names of helper types to load. Example
helpers(['string', 'array'])will load only thestringandarrayhelpers - helper types can alternatively be accessed as methods. example -
helpers.path()will return all of the path helpers. - handlebars may be provided by the user. if not provided it will fall back to the
handlebars-helpershandlebars - helpers are now as generic as possible, with little to no code related to assemble, grunt, etc.
- helpers are lazy-loaded using getters for improved performance
- Once tests are added for the
mdandmarkdownhelpers, we'll have 100% unit test coverage on helpers
v0.3.3 - 2013-09-03
changes
- Adds fileSize helper.
- Adds startsWith helper.
v0.3.2 - 2013-08-20
changes
- Adds glob helper.
v0.3.0 - 2013-07-30
changes
- The project has been refactored, cleaned up, and full documentation has bee put up at http://assemble.io
v0.2.4 - 2013-05-11
changes
- Adding object globbing utility functions to be used in helpers later.
v0.2.3 - 2013-05-11
changes
- File globbing added to some helpers. Including md and some file helpers.
v0.2.0 - 2013-05-07
changes
- A bunch of new tests for markdown and special helpers.
- Refactored most of the rest of the helpers to separate functions from Handlebars registration.
v0.1.32 - 2013-05-02
changes
- Updates utils and a number of helpers, including value, property, and stringify.
v0.1.31 - 2013-04-21
changes
- Fixes relative helper
v0.1.30 - 2013-04-20
changes
- Refactoring helpers-collection module to separate the functions from the Handlebars helper registration process.
v0.1.25 - 2013-04-16
changes
- Adding defineSection and renderSection helpers to try to get sections populated in a layout from the page.
v0.1.21 - 2013-04-07
changes
- Add markdown helpers back, add more tests.
v0.1.20 - 2013-04-06
changes
- Generalized helpers structure, externalized utilities.
v0.1.11 - 2013-04-05
changes
- New authors and gist helpers, general cleanup and new tests.
v0.1.10 - 2013-04-04
changes
- Externalized utility javascript from helpers.js
v0.1.8 - 2013-03-28
changes
- Gruntfile updated with mocha tests for 71 helpers, bug fixes.
v0.1.7 - 2013-03-18
changes
- New path helper 'relative', for resolving relative path from one absolute path to another.
v0.1.3 - 2013-03-16
changes
- New helpers, 'formatPhoneNumber' and 'eachProperty'
v0.1.2 - 2013-03-15
changes
- Update README.md with documentation, examples.
changes
- First commit.
- assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
- template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
- utils: Fast, generic JavaScript/node.js utility functions. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(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:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning 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:
$ npm install && npm testBrian Woodward
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. When this project was created some helpers were sourced from Swag, by Elving Rodriguez. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on November 17, 2017.