handlebars-helpers
Advanced tools
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.
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.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm install --save handlebars-helpers
See 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.
var helpers = require('handlebars-helpers')();
//=> returns object with all (130+) helpers
Get a specific 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` helpers
Optionally 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 145 helpers in 19 categories:
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
Visit the: code | unit tests | issues)
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 exluding n items.Example
{{after "['a', 'b', 'c']" 1}}
//=> '["c"]'
Cast the given value to an array.
Params
value {any}returns {Array}Example
{{arrayify "foo"}}
//=> '["foo"]'
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
{{before "['a', 'b', 'c']" 2}}
//=> '["a", "b"]'
Params
array {Array}options {Object}returns {String}Example
{{#eachIndex collection}}
{{item}} is {{index}}
{{/eachIndex}}
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
{{#filter array "foo"}}AAA{{else}}BBB{{/filter}}
//=> 'BBB
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
{{first "['a', 'b', 'c', 'd', 'e']" 2}}
//=> '["a", "b"]'
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:
indextotalisFirstisLast
Also, @index is exposed as a private variable, and additional
private variables may be defined as hash arguments.Params
array {Array}returns {String}Example
var accounts = [
{'name': 'John', 'email': 'john@example.com'},
{'name': 'Malcolm', 'email': 'malcolm@example.com'},
{'name': 'David', 'email': 'david@example.com'}
];
// example usage
// {{#forEach accounts}}
// <a href="mailto:{{ email }}" title="Send an email to {{ name }}">
// {{ name }}
// </a>{{#unless isLast}}, {{/unless}}
// {{/forEach}}
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.
Given the array ['a', 'b', 'c']:
Params
array {Array}value {any}options {Object}returns {String}Example
{{#inArray array "d"}}
foo
{{else}}
bar
{{/inArray}}
Returns true if value is an es5 array.
Params
value {any}: The value to test.returns {Boolean}Example
{{isArray "abc"}}
//=> 'false'
Join all elements of array into a string, optionally using a given separator.
Params
array {Array}sep {String}: The separator to use.returns {String}Example
{{join "['a', 'b', 'c']"}}
//=> 'a, b, c'
{{join "['a', 'b', 'c']" '-'}}
//=> 'a-b-c'
Returns the last item, or last n items of an array. Opposite of first.
Params
array {Array}n {Number}: Number of items to return, starting with the last item.returns {Array}Example
{{last "['a', 'b', 'c', 'd', 'e']" 2}}
//=> '["d", "e"]'
Block helper that compares the length of the given array to
the number passed as the second argument. If the array length
is equal to the given length, the block is returned,
otherwise an inverse block may optionally be returned.
Params
array {Array}length {Number}options {Object}returns {String}Returns a new array, created by calling function on each element of the given array.
Params
array {Array}fn {Function}returns {String}Example
// register `double` as a helper
function double(str) {
return str + str;
}
// then used like this:
// {{map "['a', 'b', 'c']" double}}
//=> '["aa", "bb", "cc"]'
Block helper that returns the block if the callback returns true for some value in the given array.
Params
array {Array}cb {Function}: callback functionreturns {Array}Example
{{#some array isString}}
Render me if the array has a string.
{{else}}
Render me if it doesn't.
{{/some}}
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 "['b', 'a', 'c']"}}
//=> 'a,b,c'
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
{{sortBy '["b", "a", "c"]'}}
//=> 'a,b,c'
{{sortBy '[{a: "zzz"}, {a: "aaa"}]' "a"}}
//=> '[{"a":"aaa"},{"a":"zzz"}]'
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}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
{{#withBefore array 3}}
{{this}}
{{/withBefore}}
Use the first item in a collection inside a handlebars block expression. Opposite of withLast.
Params
array {Array}idx {Number}options {Object}returns {String}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}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}Embed code from an external file as preformatted text.
Params
fp {String}: filepath to the file to embed.language {String}: Optionally specify the language to use for syntax highlighting.returns {String}Example
{{embed 'path/to/file.js'}}
// specify the language to use
{{embed 'path/to/file.hbs' 'html')}}
Embed a GitHub Gist using only the id of the Gist
Params
id {String}returns {String}Example
{{gist "12345"}}
Generate the HTML for a jsFiddle link with the given params
Params
params {Object}returns {String}Example
{{jsfiddle id="0dfk10ks" tabs="true"}}
Block helper that returns a block if the given collection is empty. If the collection is not empty the inverse block is returned (if supplied).
Params
collection {Object}options {Object}returns {String}Iterate over an array or object,
Params
context {Object|Array}: The collection to iterate overoptions {Object}returns {String}Returns the length of the given collection.
Params
value {Array|Object|String}returns {Number}: The length of the value.Example
{{length "['a', 'b', 'c']"}}
//=> 3
Block 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.
Params
a {any}b {any}options {Object}: Handlebars provided options objectreturns {String}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.
Given the array ['a', 'b', 'c']:
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
{{#contains array "d"}}
This will not be rendered.
{{else}}
This will be rendered.
{{/contains}}
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}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.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
{{#ifEven value}}
render A
{{else}}
render B
{{/ifEven}}
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
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
{{#ifOdd value}}
render A
{{else}}
render B
{{/ifOdd}}
Block helper that renders a block if a is equal to b.
If an inverse block is specified it will be rendered when falsy.
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.
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.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
{{#or a b c}}
If any value is true this will be rendered.
{{/or}}
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
context {Object}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 less than b.
Params
context {Object}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 greater than or equal to b.
Params
context {Object}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
context {Object}options {Object}: Handlebars provided options objectreturns {String}: Block, or inverse block if specified and falsey.Expose moment helper
Converts bytes into a nice representation with unit.
Examples:
13661855 => 13.7 MB825399 => 825 KB1396 => 1 KBParams
value {String}returns {String}Read a file from the file system. This is useful in composing "include"-style helpers using sub-expressions.
Params
filepath {String}returns {String}Example
{{read "a/b/c.js"}}
{{someHelper (read "a/b/c.md")}}
Return an array of files from the given directory.
Params
directory {String}returns {Array}Add an array of <link> tags. Automatically resolves
relative paths to options.assets if passed on the context.
Params
context {Object}returns {String}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
{{ellipsis "<span>foo bar baz</span>", 7}}
//=> 'foo bar…'
Generate one or more <script></script> tags with paths/urls to javascript or coffeescript files.
Params
context {Object}returns {String}Example
{{js scripts}}
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
{{sanitize "<span>foo</span>"}}
//=> 'foo'
Truncate a string by removing all HTML tags and limiting the result to the specified length. Aslo 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.returns {String}: The truncated string.Example
truncate("<span>foo bar baz</span>", 7);
//=> 'foo bar'
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}Params
count {Number}singular {String}: The singular formplural {String}: The plural forminclude {String}returns {String}Returns an ordinalized number (as a string).
Params
val {String}: The value to ordinalize.returns {String}: The ordinalized numberExample
{{ordinalize 1}}
//=> '1st'
{{ordinalize 21}}
//=> '21st'
{{ordinalize 29}}
//=> '29th'
{{ordinalize 22}}
//=> '22nd'
Block helper that converts a string of inline markdown to HTML.
Params
context {Object}options {Object}returns {String}Example
{{#markdown}}
# Foo
{{/markdown}}
//=> <h1>Foo</h1>
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
{{md "foo/bar.md"}}
The main function. Pass an array of filepaths, and a string or array of glob patterns. Options may be passed on the hash or on this.options.
Params
files {Array|String}patterns {Array|String}: One or more glob patterns.options {Object}returns {Array}: Array of matchesExample
{{match (readdir "foo") "*.js"}}
Returns an array of files that match the given glob pattern. Options may be passed on the hash or on this.options.
Params
files {Array}pattern {String}options {Object}returns {Array}Example
{{match (readdir "foo") "*.js"}}
Returns true if a filepath contains the given pattern. Options may be passed on the hash or on this.options.
Params
filepath {String}pattern {String}options {Object}returns {Boolean}Example
{{isMatch "foo.md" "*.md"}}
//=> true
Return the product of a plus b.
Params
a {Number}b {Number}Return the product of a minus b.
Params
Divide a by b
Params
a {Number}: numeratorb {Number}: denominatorMultiply a by b.
Params
a {Number}: factorb {Number}: multiplierGet the Math.floor() of the given value.
Params
value {Number}Get the Math.ceil() of the given value.
Params
value {Number}Round the given value.
Params
value {Number}Returns the sum of all numbers in the given array.
Params
array {Array}: Array of numbers to add up.returns {Number}Example
{{sum "[1, 2, 3, 4, 5]"}}
//=> '15'
Returns the average of all numbers in the given array.
Params
array {Array}: Array of numbers to add up.returns {Number}Example
{{avg "[1, 2, 3, 4, 5]"}}
//=> '3'
Returns the first value if defined, otherwise the "default" value is returned.
Params
value {any}defaultValue {any}returns {String}Return the given value of prop from this.options. Given the context {options: {a: {b: {c: 'ddd'}}}}
Params
prop {String}returns {any}Example
{{option "a.b.c"}}
<!-- results => `ddd` -->
Block helper that renders the block without taking any arguments.
Params
options {Object}returns {String}Block helper that builds the context for the block from the options hash.
Params
options {Object}: Handlebars provided options object.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-1212Generate a random number between two values
Params
min {Number}max {Number}returns {String}Abbreviate numbers to the given number of precision. This is for
general numbers, not size in bytes.
Params
number {String}precision {String}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
{{toExponential number digits}};
Formats the given number using fixed-point notation.
Params
number {Number}digits {Number}: Optional. The number of digits to use after the decimal point; this may be a value between 0 and 20, inclusive, and implementations may optionally support a larger range of values. If this argument is omitted, it is treated as 0.returns {Number}Params
number {Number}returns {Number}Params
number {Number}returns {Number}Params
number {Number}precision {Number}: Optional. The number of significant digits.returns {Number}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}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
{{hasOwn context key}}
Return true if value is an object.
Params
value {String}returns {Boolean}Example
{{isObject "foo"}}
//=> false
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}Block helper that parses a string using JSON.parse,
then passes the parsed object to the block as context.
Params
string {String}: The string to parseoptions {Object}: Handlebars options objectPick properties from the context object.
Params
properties {Array|String}: One or more proeperties 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.Stringify an object using JSON.stringify.
Params
obj {Object}: Object to stringifyreturns {String}Get the directory path segment from the given filepath.
Params
ext {String}returns {String}Example
{{absolute "docs/toc.md"}}
//=> 'docs'
Get the directory path segment from the given filepath.
Params
ext {String}returns {String}Example
{{dirname "docs/toc.md"}}
//=> 'docs'
Get the relative filepath from a to b.
Params
a {String}b {String}returns {String}Example
{{relative a b}}
Get the file extension from the given filepath.
Params
ext {String}returns {String}Example
{{basename "docs/toc.md"}}
//=> 'toc.md'
Get the "stem" from the given filepath.
Params
filepath {String}returns {String}Example
{{stem "docs/toc.md"}}
//=> 'toc'
Get the file extension from the given filepath.
Params
filepath {String}returns {String}Example
{{extname "docs/toc.md"}}
//=> '.md'
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
{{segments "a/b/c/d" "2" "3"}}
//=> 'c/d'
{{segments "a/b/c/d" "1" "3"}}
//=> 'b/c/d'
{{segments "a/b/c/d" "1" "2"}}
//=> 'b/c'
camelCase the characters in the given string.
Params
string {String}: The string to camelcase.returns {String}Example
{{camelcase "foo bar baz"}};
//=> 'fooBarBaz'
Capitalize the first word in a sentence.
Params
str {String}returns {String}Example
{{capitalize "foo bar baz"}}
//=> "Foo bar baz"
Capitalize all words in a string.
Params
str {String}returns {String}Example
{{capitalize "foo bar baz"}}
//=> "Foo Bar Baz"
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
{{chop "_ABC_"}}
//=> 'ABC'
{{chop "-ABC-"}}
//=> 'ABC'
{{chop " ABC "}}
//=> 'ABC'
dash-case the characters in string. Replaces non-word characters and periods with hyphens.
Params
string {String}returns {String}Example
{{dashcase "a-b-c d_e"}}
//=> 'a-b-c-d-e'
dot.case the characters in string.
Params
string {String}returns {String}Example
{{dotcase "a-b-c d_e"}}
//=> 'a.b.c.d.e'
Replace spaces in a string with hyphens.
Params
str {String}returns {String}Example
{{hyphenate "foo bar baz qux"}}
//=> "foo-bar-baz-qux"
Return true if value is a string.
Params
value {String}returns {Boolean}Example
{{isString "foo"}}
//=> 'true'
Lowercase all characters in the given string.
Params
str {String}returns {String}Example
{{lowercase "Foo BAR baZ"}}
//=> 'foo bar baz'
Return the number of occurrances of substring within the given string.
Params
str {String}substring {String}returns {Number}: Number of occurrancesExample
{{occurrances "foo bar foo bar baz" "foo"}}
//=> 2
PascalCase the characters in string.
Params
string {String}returns {String}Example
{{pascalcase "foo bar baz"}}
//=> 'FooBarBaz'
path/case the characters in string.
Params
string {String}returns {String}Example
{{pathcase "a-b-c d_e"}}
//=> 'a/b/c/d/e'
Replace spaces in the given string with pluses.
Params
str {String}: The input stringreturns {String}: Input string with spaces replaced by plus signsExample
{{plusify "foo bar baz"}}
//=> 'foo+bar+baz'
Reverse a string.
Params
str {String}returns {String}Example
{{reverse "abcde"}}
//=> 'edcba'
Replace all occurrences of a with b.
Params
str {String}a {String}b {String}returns {String}Example
{{replace "a b a b a b" "a" "z"}}
//=> 'z b z b z b'
Sentence case the given string
Params
str {String}returns {String}Example
{{sentence "hello world. goodbye world."}}
//=> 'Hello world. Goodbye world.'
snake_case the characters in the given string.
Params
string {String}returns {String}Example
{{snakecase "a-b-c d_e"}}
//=> 'a_b_c_d_e'
Split string by the given character.
Params
string {String}: The string to split.returns {String} character: Default is ,Example
{{split "a,b,c" ","}}
//=> ['a', 'b', 'c']
Tests whether a string begins with the given prefix.
Params
prefix {String}testString {String}options {String}returns {String}Example
{{#startsWith "Goodbye" "Hello, world!"}}
Whoops
{{else}}
Bro, do you even hello world?
{{/startsWith}}
Title case the given string.
Params
str {String}returns {String}Example
{{titleize "this is title case"}}
//=> 'This Is Title Case'
Removes extraneous whitespace from the beginning and end of a string.
Params
string {String}: The string to trim.returns {String}Example
{{trim " ABC "}}
//=> 'ABC'
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}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 stringDecode a Uniform Resource Identifier (URI) component.
Params
str {String}returns {String}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 JSONStrip the query string from the give url.
Params
url {String}returns {String}The following utils are exposed on .utils.
Converts a "regex-string" to an actual regular expression.
Params
value {Object}returns {Boolean}Example
utils.toRegex('"/foo/"');
//=> /foo/
Returns true if the given value appears to be a regular expression.
Params
value {Object}returns {Boolean}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
utils.changecase('fooBarBaz');
//=> 'foo bar baz'
utils.changecase('fooBarBaz' '-');
//=> 'foo-bar-baz'
Generate a random number
Params
min {Number}max {Number}returns {Number}Returns true if the given value is undefined or
is a handlebars options hash.
Params
value {any}returns {Boolean}Returns true if the given value appears to be an options object.
Params
value {Object}returns {Boolean}Get options from the options hash and this.
Params
app {Object}: The current application instance.returns {Object}Returns true if the given value is an object and not an array.
Params
value {any}returns {Boolean}Returns true if the given value is empty.
Params
value {any}returns {Boolean}Try to parse the given string as JSON. Fails
gracefully if the value cannot be parsed.
Params
string {String}returns {Object}Return the given value. If the value is a function it will be called, and the result is returned.
Params
val {any}returns {any}Return the given value, unchanged.
Params
val {any}returns {any}Return true if val is a string.
Params
val {any}: The value to checkreturns {Boolean}Cast val to an array.
Params
val {any}: The value to arrayify.returns {Array}changes
changes
changes
helpers(['string', 'array']) will load only the string and array helpershelpers.path() will return all of the path helpers.handlebars-helpers handlebarsmd and markdown helpers, we'll have 100% unit test coverage on helperschanges
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
changes
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Brian 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.3.0, on January 25, 2017.
FAQs
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.
We found that handlebars-helpers demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.