logo
Fork me on GitHub

fumanchu

Handlebars + Helpers Together

tests codecov npm version GitHub license npm

Handlebars + Handlebars-helpers (helpers are now maintained in this project) combined into a single package. Easily use in your nodejs as it is a drop in replacement when using handlebars directly.

Table of Contents

Usage Nodejs

npm install @jaredwray/fumanchu --save
    // or
    yarn add @jaredwray/fumanchu
    
var handlebars = require('@jaredwray/fumanchu');
    var template = handlebars.compile('{{#if (eq foo "bar")}}
Foo is bar
{{/if}}');
    var html = template({foo: 'bar'});
    console.log(html);

If using it with es6 you can access handlebars via destructuring:

import handlebars from '@jaredwray/fumanchu';
    const template = handlebars.compile('{{#if (eq foo "bar")}}
Foo is bar
{{/if}}');
    const html = template({foo: 'bar'});
    console.log(html);

It's just that easy! No need to add Handlebars to your project, it's already included.

Using Handlebars Helpers

If you only want to use handlebar helpers you can easily do that by doing the following:

var helpers = require('@jaredwray/fumanchu').handlebarHelpers;
    var handlebars = require('handlebars');
    helpers({ handlebars: handlebars });
    var fn = handlebars.compile('{{add value 5}}');
    console.log(fn);

If using it with es6 you can access helpers via destructuring:

import fumanchu from '@jaredwray/fumanchu';
    import handlebars from 'handlebars';
    const {handlebarHelpers} = fumanchu;
    handlebarHelpers({ handlebars: handlebars });
    const template = handlebars.compile('{{#if (eq foo "bar")}}
Foo is bar
{{/if}}');
    const html = template({foo: 'bar'});
    console.log(html);

Notice that in this scenario you are accessing helpers via helpers from fumanchu instead of just using handlebars via fumanchu directly.

Helpers

More than 180 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.

Categories

Currently 189 helpers in 20 categories:

All helpers

array helpers

Visit the: code | unit tests | issues)

code helpers

Visit the: code | unit tests | issues)

collection helpers

Visit the: code | unit tests | issues)

comparison helpers

Visit the: code | unit tests | issues)

date helpers

Visit the: code | unit tests | issues)

fs helpers

Visit the: code | unit tests | issues)

html helpers

Visit the: code | unit tests | issues)

i18n helpers

Visit the: code | unit tests | issues)

inflection helpers

Visit the: code | unit tests | issues)

logging helpers

Visit the: code | unit tests | issues)

markdown helpers

Visit the: code | unit tests | issues)

match helpers

Visit the: code | unit tests | issues)

math helpers

Visit the: code | unit tests | issues)

misc helpers

Visit the: code | unit tests | issues)

number helpers

Visit the: code | unit tests | issues)

object helpers

Visit the: code | unit tests | issues)

path helpers

Visit the: code | unit tests | issues)

regex helpers

Visit the: code | unit tests | issues)

string helpers

Visit the: code | unit tests | issues)

url helpers

Visit the: code | unit tests | issues)

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 exluding n items.

Example


    {{after array 1}}

{{arrayify}}

Cast the given value to an array.

Params

  • value {any}
  • returns {Array}

Example

{{arrayify "foo"}}

{{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


    {{before array 2}}

{{eachIndex}}

Params

  • array {Array}
  • options {Object}
  • returns {String}

Example


    {{#eachIndex array}}
      {{item}} is {{index}}
    {{/eachIndex}}

{{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


    {{#filter array "foo"}}AAA{{else}}BBB{{/filter}}

{{first}}

Returns the first item, or first n items of an array.

Params

  • array {Array}
  • n {Number}: Number of items to return, starting at 0.
  • returns {Array}

Example

{{first "['a', 'b', 'c', 'd', 'e']" 2}}

{{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


    
    {{#forEach accounts}}
      
        {{ name }}
      {{#unless isLast}}, {{/unless}}
    {{/forEach}}

{{inArray}}

Block helper that renders the block if an array has the given value. Optionally specify an inverse block to render when the array does not have the given value.

Params

  • array {Array}
  • value {any}
  • options {Object}
  • returns {String}

Example


    {{#inArray array "d"}}
      foo
    {{else}}
      bar
    {{/inArray}}

{{isArray}}

Returns true if value is an es5 array.

Params

  • value {any}: The value to test.
  • returns {Boolean}

Example

{{isArray "abc"}}
    
    
    
    {{isArray array}}

{{itemAt}}

Returns the item from array at index idx.

Params

  • array {Array}
  • idx {Number}
  • returns {any} value

Example


    {{itemAt array 1}}

{{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


    {{join array}}
    
    
    {{join array '-'}}

{{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


    
    {{last value}}
    
    
    {{last value 2}}
    
    
    {{last value 3}}

{{length}}

Returns the length of the given string or array.

Params

  • value {Array|Object|String}
  • returns {Number}: The length of the value.

Example

{{length '["a", "b", "c"]'}}
    
    
    
    {{length myArray}}
    
    
    
    {{length myObject}}

{{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


    {{map array double}}

{{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

// {{pluck items "data.title"}}

{{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


    {{reverse value}}
    
    
    {{reverse value}}

{{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


    {{#some array isString}}
      Render me if the array has a string.
    {{else}}
      Render me if it doesn't.
    {{/some}}

{{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


    {{sort array}}

{{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


    {{sortBy array "a"}}

{{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


    {{#withAfter array 3}}
      {{this}}
    {{/withAfter}}

{{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


    {{#withBefore array 3}}
      {{this}}
    {{/withBefore}}

{{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


    {{#withFirst array}}
      {{this}}
    {{/withFirst}}

{{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


    {{#withGroup array 4}}
      {{#each this}}
        {{.}}
      {{each}}
      

    {{/withGroup}}

{{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


    {{#withLast array}}
      {{this}}
    {{/withLast}}

{{withSort}}

Block helper that sorts a collection and exposes the sorted collection as context inside the block.

Params

  • array {Array}
  • prop {String}
  • options {Object}: Specify reverse="true" to reverse the array.
  • returns {String}

Example


    {{#withSort array}}{{this}}{{/withSort}}

{{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


    {{#each (unique array)}}{{.}}{{/each}}

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

{{embed 'path/to/file.js'}}
    
    {{embed 'path/to/file.hbs' 'html')}}

{{gist}}

Embed a GitHub Gist using only the id of the Gist

Params

  • id {String}
  • returns {String}

Example

{{gist "12345"}}

{{jsfiddle}}

Generate the HTML for a jsFiddle link with the given params

Params

  • params {Object}
  • returns {String}

Example

{{jsfiddle id="0dfk10ks" tabs="true"}}

collection

{{isEmpty}}

Inline, subexpression, or block helper that returns true (or the block) if the given collection is empty, or false (or the inverse block, if supplied) if the colleciton is not empty.

Params

  • collection {Object}
  • options {Object}
  • returns {String}

Example


    {{#isEmpty array}}AAA{{else}}BBB{{/isEmpty}}
    
    
    
    {{isEmpty array}}

{{iterate}}

Block helper that iterates over an array or object. If an array is given, .forEach is called, or if an object is given, .forOwn is called, otherwise the inverse block is returned.

Params

  • collection {Object|Array}: The collection to iterate over
  • options {Object}
  • returns {String}

comparison

{{and}}

Helper that renders the block if both of the given values are truthy. If an inverse block is specified it will be rendered when falsy. Works as a block helper, inline helper or subexpression.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}

Example


    {{#and great magnificent}}A{{else}}B{{/and}}

{{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


    {{#contains array "d"}}
      This will not be rendered.
    {{else}}
      This will be rendered.
    {{/contains}}

{{default}}

Returns the first value that is not undefined, otherwise the "default" value is returned.

Params

  • value {any}
  • defaultValue {any}
  • returns {String}

{{eq}}

Block helper that renders a block if a is equal to b. If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{gt}}

Block helper that renders a block if a is greater than b.

If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{gte}}

Block helper that renders a block if a is greater than or equal to b.

If an inverse block is specified it will be rendered when falsy. You may optionally use the compare="" hash argument for the second value.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{has}}

Block helper that renders a block if value has pattern. If an inverse block is specified it will be rendered when falsy.

Params

  • val {any}: The value to check.
  • pattern {any}: The pattern to check for.
  • options {Object}: Handlebars provided options object
  • returns {String}

{{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

{{#ifEven value}}
      render A
    {{else}}
      render B
    {{/ifEven}}

{{ifNth}}

Conditionally renders a block if the remainder is zero when a operand is divided by b. If an inverse block is specified it will be rendered when the remainder is not zero.

Params

  • {}: {Number}
  • {}: {Number}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{ifOdd}}

Block helper that renders a block if value is an odd number. If an inverse block is specified it will be rendered when falsy.

Params

  • value {Object}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

Example

{{#ifOdd value}}
      render A
    {{else}}
      render B
    {{/ifOdd}}

{{is}}

Block helper that renders a block if a is equal to b. If an inverse block is specified it will be rendered when falsy. Similar to eq 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

{{#or a b c}}
      If any value is true this will be rendered.
    {{/or}}

{{unlessEq}}

Block helper that always renders the inverse block unless a is is equal to b.

Params

  • a {String}
  • b {String}
  • options {Object}: Handlebars provided options object
  • returns {String}: Inverse block by default, or block if falsey.

{{unlessGt}}

Block helper that always renders the inverse block unless a is is greater than b.

Params

  • a {Object}: The default value
  • b {Object}: The value to compare
  • options {Object}: Handlebars provided options object
  • returns {String}: Inverse block by default, or block if falsey.

{{unlessLt}}

Block helper that always renders the inverse block unless a is is less than b.

Params

  • a {Object}: The default value
  • b {Object}: The value to compare
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{unlessGteq}}

Block helper that always renders the inverse block unless a is is greater than or equal to b.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

{{unlessLteq}}

Block helper that always renders the inverse block unless a is is less than or equal to b.

Params

  • a {any}
  • b {any}
  • options {Object}: Handlebars provided options object
  • returns {String}: Block, or inverse block if specified and falsey.

date

{{year}}

Get the current year.

Example

{{year}}

{{moment}}

Use moment as a helper. See helper-date for more details.

fs

{{read}}

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")}}

{{readdir}}

Return an array of files from the given directory.

Params

  • directory {String}
  • returns {Array}

html

{{attr}}

Stringify attributes on the options hash.

Params

  • options {Object}
  • returns {String}

Example
{{css stylesheets}}

{{js}}

Generate one or more tags with paths/urls to javascript or coffeescript files.

Params

Example

{{js scripts}}

{{sanitize}}

Strip HTML tags from a string, so that only the text nodes are preserved.

Params

Example

{{sanitize "foo"}}

{{ul}}

Block helper for creating unordered lists (

)

Params

{{ol}}

Block helper for creating ordered lists (

    )

    Params

    {{thumbnailImage}}

    Returns a

    with a thumbnail linked to a full picture

    Params

    i18n

    {{i18n}}

    i18n helper. See button-i18n for a working example.

    Params

    inflection

    {{inflect}}

    Returns either the singular or plural inflection of a word based on the given count.

    Params

    Example

    {{inflect 0 "string" "strings"}}
    
    {{inflect 1 "string" "strings"}}
    
    {{inflect 1 "string" "strings" true}}
    
    {{inflect 2 "string" "strings"}}
    
    {{inflect 2 "string" "strings" true}}

    {{ordinalize}}

    Returns an ordinalized number as a string.

    Params

    Example

    {{ordinalize 1}}
    
    {{ordinalize 21}}
    
    {{ordinalize 29}}
    
    {{ordinalize 22}}

    logging

    logging-helpers.

    markdown

    {{markdown}}

    Block helper that converts a string of inline markdown to HTML.

    Params

    Example

    {{#markdown}}
    # Foo
    {{/markdown}}

    {{md}}

    Read a markdown file from the file system and inject its contents after converting it to HTML.

    Params

    Example

    {{md "foo/bar.md"}}

    match

    {{match}}

    Returns an array of strings that match the given glob pattern(s). Options may be passed on the options hash or locals.

    Params

    Example

    {{match (readdir "foo") "*.js"}}
    {{match (readdir "foo") (toRegex "\\.js$")}}

    {{isMatch}}

    Returns true if a filepath contains the given pattern. Options may be passed on the options hash or locals.

    Params

    Example

    {{isMatch "foo.md" "*.md"}}

    math

    {{abs}}

    Return the magnitude of a.

    Params

    {{add}}

    Return the sum of a plus b.

    Params

    {{avg}}

    Returns the average of all numbers in the given array.

    Params

    Example

    {{avg "[1, 2, 3, 4, 5]"}}

    {{ceil}}

    Get the Math.ceil() of the given value.

    Params

    {{divide}}

    Divide a by b

    Params

    {{floor}}

    Get the Math.floor() of the given value.

    Params

    {{minus}}

    Return the difference of a minus b.

    Params

    {{modulo}}

    Get the remainder of a division operation.

    Params

    {{multiply}}

    Return the product of a times b.

    Params

    {{plus}}

    Add a by b.

    Params

    {{random}}

    Generate a random number between two values

    Params

    {{remainder}}

    Get the remainder when a is divided by b.

    Params

    {{round}}

    Round the given number.

    Params

    {{subtract}}

    Return the product of a minus b.

    Params

    {{sum}}

    Returns the sum of all numbers in the given array.

    Params

    Example

    {{sum "[1, 2, 3, 4, 5]"}}

    {{times}}

    Multiply number a by number b.

    Params

    misc

    {{option}}

    Return the given value of prop from this.options.

    Params

    Example

    
    {{option "a.b.c"}}

    {{noop}}

    Block helper that renders the block without taking any arguments.

    Params

    {{typeOf}}

    Get the native type of the given value

    Params

    Example

    {{typeOf 1}}
    //=> 'number'
    {{typeOf "1"}}
    //=> 'string'
    {{typeOf "foo"}}
    //=> 'string'

    {{withHash}}

    Block helper that builds the context for the block from the options hash.

    Params

    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:

    Params

    {{addCommas}}

    Add commas to numbers

    Params

    {{phoneNumber}}

    Convert a string or number to a formatted phone number.

    Params

    {{toAbbr}}

    Abbreviate numbers to the given number of precision. This is for general numbers, not size in bytes.

    Params

    {{toExponential}}

    Returns a string representing the given number in exponential notation.

    Params

    Example

    {{toExponential number digits}};

    {{toFixed}}

    Formats the given number using fixed-point notation.

    Params

    Example

    {{toFixed "1.1234" 2}}
    //=> '1.12'

    {{toFloat}}

    Params

    {{toInt}}

    Params

    {{toPrecision}}

    Returns a string representing the Number object to the specified precision.

    Params

    Example

    {{toPrecision "1.1234" 2}}
    //=> '1.1'

    object

    {{extend}}

    Extend the context with the properties of other objects. A shallow merge is performed to avoid mutating the context.

    Params

    {{forIn}}

    Block helper that iterates over the properties of an object, exposing each key and value on the context.

    Params

    {{forOwn}}

    Block helper that iterates over the own properties of an object, exposing each key and value on the context.

    Params

    {{toPath}}

    Take arguments and, if they are string or number, convert them to a dot-delineated object property path.

    Params

    {{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

    {{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

    {{hasOwn}}

    Return true if key is an own, enumerable property of the given context object.

    Params

    Example

    {{hasOwn context key}}

    {{isObject}}

    Return true if value is an object.

    Params

    Example

    {{isObject "foo"}}
    //=> false

    {{JSONparse}}

    Parses the given string using JSON.parse.

    Params

    Example

    
    {{JSONparse string}}

    {{JSONstringify}}

    Stringify an object using JSON.stringify.

    Params

    Example

    
    {{JSONstringify object}}

    {{merge}}

    Deeply merge the properties of the given objects with the context object.

    Params

    {{pick}}

    Pick properties from the context object.

    Params

    path

    {{absolute}}

    Get the directory path segment from the given filepath.

    Params

    Example

    {{absolute "docs/toc.md"}}

    {{dirname}}

    Get the directory path segment from the given filepath.

    Params

    Example

    {{dirname "docs/toc.md"}}

    {{relative}}

    Get the relative filepath from a to b.

    Params

    Example

    {{relative a b}}

    {{basename}}

    Get the file extension from the given filepath.

    Params

    Example

    {{basename "docs/toc.md"}}

    {{stem}}

    Get the "stem" from the given filepath.

    Params

    Example

    {{stem "docs/toc.md"}}

    {{extname}}

    Get the file extension from the given filepath.

    Params

    Example

    {{extname "docs/toc.md"}}

    {{resolve}}

    Resolve an absolute path from the given filepath.

    Params

    Example

    {{resolve "docs/toc.md"}}

    {{segments}}

    Get specific (joined) segments of a file path by passing a range of array indices.

    Params

    Example

    {{segments "a/b/c/d" "2" "3"}}
    
    
    {{segments "a/b/c/d" "1" "3"}}
    
    
    {{segments "a/b/c/d" "1" "2"}}

    regex

    {{toRegex}}

    Convert the given string to a regular expression.

    Params

    Example

    {{toRegex "foo"}}

    {{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

    Example

    {{test "bar" (toRegex "foo")}}
    
    {{test "foobar" (toRegex "foo")}}
    
    {{test "foobar" (toRegex "^foo$")}}

    string

    {{append}}

    Append the specified suffix to the given string.

    Params

    Example

    
    {{append item.stem ".html"}}

    {{camelcase}}

    camelCase the characters in the given string.

    Params

    Example

    {{camelcase "foo bar baz"}};

    {{capitalize}}

    Capitalize the first word in a sentence.

    Params

    Example

    {{capitalize "foo bar baz"}}

    {{capitalizeAll}}

    Capitalize all words in a string.

    Params

    Example

    {{capitalizeAll "foo bar baz"}}

    {{center}}

    Center a string using non-breaking spaces

    Params

    {{chop}}

    Like trim, but removes both extraneous whitespace and non-word characters from the beginning and end of a string.

    Params

    Example

    {{chop "_ABC_"}}
    
    
    {{chop "-ABC-"}}
    
    
    {{chop " ABC "}}

    {{dashcase}}

    dash-case the characters in string. Replaces non-word characters and periods with hyphens.

    Params

    Example

    {{dashcase "a-b-c d_e"}}

    {{dotcase}}

    dot.case the characters in string.

    Params

    Example

    {{dotcase "a-b-c d_e"}}

    {{downcase}}

    Lowercase all of the characters in the given string. Alias for lowercase.

    Params

    Example

    {{downcase "aBcDeF"}}

    {{ellipsis}}

    Truncates a string to the specified length, and appends it with an elipsis, ….

    Params

    Example

    {{ellipsis (sanitize "foo bar baz"), 7}}
    
    {{ellipsis "foo bar baz", 7}}

    {{hyphenate}}

    Replace spaces in a string with hyphens.

    Params

    Example

    {{hyphenate "foo bar baz qux"}}

    {{isString}}

    Return true if value is a string.

    Params

    Example

    {{isString "foo"}}

    {{lowercase}}

    Lowercase all characters in the given string.

    Params

    Example

    {{lowercase "Foo BAR baZ"}}

    {{occurrences}}

    Return the number of occurrences of substring within the given string.

    Params

    Example

    {{occurrences "foo bar foo bar baz" "foo"}}

    {{pascalcase}}

    PascalCase the characters in string.

    Params

    Example

    {{pascalcase "foo bar baz"}}

    {{pathcase}}

    path/case the characters in string.

    Params

    Example

    {{pathcase "a-b-c d_e"}}

    {{plusify}}

    Replace spaces in the given string with pluses.

    Params

    Example

    {{plusify "foo bar baz"}}

    {{prepend}}

    Prepends the given string with the specified prefix.

    Params

    Example

    
    {{prepend val "foo-"}}

    {{raw}}

    Render a block without processing mustache templates inside the block.

    Params

    Example

    {{{{#raw}}}}
    {{foo}}
    {{{{/raw}}}}

    {{remove}}

    Remove all occurrences of substring from the given str.

    Params

    Example

    {{remove "a b a b a b" "a "}}

    {{removeFirst}}

    Remove the first occurrence of substring from the given str.

    Params

    Example

    {{remove "a b a b a b" "a"}}

    {{replace}}

    Replace all occurrences of substring a with substring b.

    Params

    Example

    {{replace "a b a b a b" "a" "z"}}

    {{replaceFirst}}

    Replace the first occurrence of substring a with substring b.

    Params

    Example

    {{replace "a b a b a b" "a" "z"}}

    {{reverse}}

    Reverse a string.

    Params

    Example

    {{reverse "abcde"}}

    {{sentence}}

    Sentence case the given string

    Params

    Example

    {{sentence "hello world. goodbye world."}}

    {{snakecase}}

    snake_case the characters in the given string.

    Params

    Example

    {{snakecase "a-b-c d_e"}}

    {{split}}

    Split string by the given character.

    Params

    Example

    {{split "a,b,c" ","}}

    {{startsWith}}

    Tests whether a string begins with the given prefix.

    Params

    Example

    {{#startsWith "Goodbye" "Hello, world!"}}
      Whoops
    {{else}}
      Bro, do you even hello world?
    {{/startsWith}}

    {{titleize}}

    Title case the given string.

    Params

    Example

    {{titleize "this is title case"}}

    {{trim}}

    Removes extraneous whitespace from the beginning and end of a string.

    Params

    Example

    {{trim " ABC "}}

    {{trimLeft}}

    Removes extraneous whitespace from the beginning of a string.

    Params

    Example

    {{trim " ABC "}}

    {{trimRight}}

    Removes extraneous whitespace from the end of a string.

    Params

    Example

    {{trimRight " ABC "}}

    {{truncate}}

    Truncate a string to the specified length. Also see ellipsis.

    Params

    Example

    truncate("foo bar baz", 7);
    
    truncate(sanitize("foo bar baz", 7));

    {{truncateWords}}

    Truncate a string to have the specified number of words. Also see truncate.

    Params

    Example

    truncateWords("foo bar baz", 1);
    
    truncateWords("foo bar baz", 2);
    
    truncateWords("foo bar baz", 3);

    {{upcase}}

    Uppercase all of the characters in the given string. Alias for uppercase.

    Params

    Example

    {{upcase "aBcDeF"}}

    {{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

    Example

    {{uppercase "aBcDeF"}}

    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

    {{escape}}

    Escape the given string by replacing characters with escape sequences. Useful for allowing the string to be used in a URL, etc.

    Params

    {{decodeURI}}

    Decode a Uniform Resource Identifier (URI) component.

    Params

    {{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

    {{urlParse}}

    Parses a url string into an object.

    Params

    {{stripQuerystring}}

    Strip the query string from the given url.

    Params

    {{stripProtocol}}

    Strip protocol from a url. Useful for displaying media that may have an 'http' protocol on secure connections.

    Params

    Example

    
    {{stripProtocol url}}

    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

    Example

    utils.changecase('fooBarBaz');
    //=> 'foo bar baz'
    
    utils.changecase('fooBarBaz' '-');
    //=> 'foo-bar-baz'

    {{random}}

    Generate a random number

    Params

    How to Contribute

    Now that you've set up your workspace, you're ready to contribute changes to the fumanchu repository you can refer to the CONTRIBUTING guide. If you have any questions please feel free to ask by creating an issue and label it question.

    License and Copyright

    MIT and codebase after 2023 will be copyright of Jared Wray.

    This is a fork of handlebars-helpers which is licensed under MIT. Initial copyright of handlebars-helpers: 2013-2015, 2017, Jon Schlinkert, Brian Woodward. Thank you so much for your effort and building this! We have also continued to list all contributors in package.json to ensure that they are recognized.

    Contributors

    jaredwray

    Latest's Releases

    v1.1.2 October 24, 2023

    What's Changed

    Full Changelog: https://github.com/jaredwray/fumanchu/compare/v1.1.1...v1.1.2

    v1.1.1 October 24, 2023

    What's Changed

    Full Changelog: https://github.com/jaredwray/fumanchu/compare/v1.0.4...v1.1.1

    v1.1.0 October 02, 2023

    What's Changed

    Full Changelog: https://github.com/jaredwray/fumanchu/compare/v1.0.3...v1.1.0