template-helpers    

> Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

- Install
- Usage
* Template-engine agnostic
* Namespacing
- Helpers
* array
* code
* collection
* conditional
* fs
* html
* index
* math
* object
* path
* string
- Coverage
- About

Install

Install with npm:

``sh
$ npm install --save template-helpers
`

Usage

To get all helpers:

`js
const helpers = require('template-helpers')();
console.log(helpers);
`

Get a specific helper category

`js
// get only the math helpers
const helpers = require('template-helpers')('math');
`

Get multiple helper categories

`js
// get only the math helpers
const helpers = require('template-helpers')(['math', 'string']);
`

$3

Lo-Dash Example

`js
const helpers = require('template-helpers')('array');

// pass helpers on imports
const imports = { imports: helpers };

// compile a template
const fn = _.template('<%= first(foo) %>', imports);

// render
fn({ foo: ['a', 'b', 'c'] });
//=> 'a'
`

$3

Handlebars and Lo-Dash both allow dot notation to be used for referencing helpers. I'd be happy to add examples for other engines if someone wants to do a PR.

Example

`js
<%= path.dirname("a/b/c/d.js") %>
`

This can be used as a way of working around potential naming conflicts.

Helpers

_(The following API Table of Contents is generated by verb. See the verbfile.js for more details.)_

Categories

Currently 101 helpers in 10 categories:

* array (code | unit tests)
* code (code | unit tests)
* collection (code | unit tests)
* conditional (code | unit tests)
* fs (code | unit tests)
* html (code | unit tests)
* math (code | unit tests)
* object (code | unit tests)
* path (code | unit tests)
* string (code | unit tests)

All helpers

$3

Visit the: code | unit tests | issues)

* isArray (code | unit tests)
* arrayify (code | unit tests)
* first (code | unit tests)
* last (code | unit tests)
* before (code | unit tests)
* after (code | unit tests)
* each (code | unit tests)
* map (code | unit tests)
* join (code | unit tests)
* sort (code | unit tests)
* length (code | unit tests)
* compact (code | unit tests)
* difference (code | unit tests)
* unique (code | unit tests)
* union (code | unit tests)
* shuffle (code | [no tests])

$3

Visit the: code | unit tests | issues)

* embed (code | unit tests)
* jsfiddle (code | unit tests)

$3

Visit the: code | unit tests | issues)

* any (code | unit tests)
* filter (code | unit tests)

$3

Visit the: code | unit tests | issues)

* and (code | [no tests])
* compare (code | unit tests)
* find (code | [no tests])
* every (code | [no tests])
* gt (code | [no tests])
* gte (code | [no tests])
* _if (code | [no tests])
* is (code | unit tests)
* eq (code | [no tests])
* isnt (code | unit tests)
* notEq (code | [no tests])
* lt (code | [no tests])
* lte (code | [no tests])
* or (code | [no tests])
* some (code | [no tests])

$3

Visit the: code | unit tests | issues)

* exists (code | unit tests)
* read (code | unit tests)

$3

Visit the: code | unit tests | issues)

* escapeHtml (code | unit tests)
* sanitize (code | unit tests)

$3

Visit the: code | unit tests | issues)

* add (code | unit tests)
* subtract (code | unit tests)
* divide (code | unit tests)
* multiply (code | unit tests)
* floor (code | unit tests)
* ceil (code | unit tests)
* round (code | unit tests)
* sum (code | unit tests)

$3

Visit the: code | unit tests | issues)

* fallback (code | unit tests)
* stringify (code | unit tests)
* parse (code | unit tests)
* get (code | [no tests])
* keys (code | unit tests)
* isObject (code | unit tests)
* isPlainObject (code | unit tests)
* hasOwn (code | unit tests)
* omit (code | unit tests)
* forIn (code | unit tests)
* forOwn (code | unit tests)
* extend (code | unit tests)
* merge (code | unit tests)

$3

Visit the: code | unit tests | issues)

* dirname (code | unit tests)
* basename (code | unit tests)
* filename (code | unit tests)
* stem (code | [no tests])
* extname (code | unit tests)
* ext (code | unit tests)
* resolve (code | unit tests)
* relative (code | unit tests)
* segments (code | unit tests)
* join (code | unit tests)
* isAbsolute (code | unit tests)
* isRelative (code | unit tests)

$3

Visit the: code | unit tests | issues)

* camelcase (code | unit tests)
* centerAlign (code | [no tests])
* chop (code | unit tests)
* count (code | unit tests)
* dotcase (code | unit tests)
* ellipsis (code | unit tests)
* isString (code | [no tests])
* lower (code | unit tests)
* lowercase (code | unit tests)
* pascalcase (code | unit tests)
* snakecase (code | unit tests)
* split (code | [no tests])
* strip (code | unit tests)
* stripIndent (code | unit tests)
* trim (code | unit tests)
* dashcase (code | unit tests)
* pathcase (code | unit tests)
* sentencecase (code | unit tests)
* hyphenate (code | unit tests)
* slugify (code | unit tests)
* reverse (code | unit tests)
* rightAlign (code | [no tests])
* replace (code | unit tests)
* titleize (code | [no tests])
* titlecase (code | unit tests)
* truncate (code | unit tests)
* upper (code | unit tests)
* uppercase (code | unit tests)
* wordwrap (code | unit tests)

$3

#### isArray

Returns true if value is an array.

Params

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

Example

`js
<%= isArray('a, b, c') %>
//=> 'false'

<%= isArray(['a, b, c']) %>
//=> 'true'
`

#### arrayify

Cast val to an array.

Params

* val {any}: The value to arrayify.
* returns {Array}: An array.
* returns {Array}

Example

`js
<%= arrayify('a') %>
//=> '["a"]'

<%= arrayify({a: 'b'}) %>
//=> '[{a: "b"}]'

<%= arrayify(['a']) %>
//=> '["a"]'
`

#### first

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

Params

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

Example

`js
<%= first(['a', 'b', 'c', 'd', 'e'], 2) %>
//=> '["a", "b"]'
`

#### last

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

Params

* array {Array}
* n {Number}: Number of items to return, starting with the last item.
* returns {Array}

Example

`js
<%= last(['a', 'b', 'c', 'd', 'e'], 2) %>
//=> '["d", "e"]'
`

#### before

Returns all of the items in an array up to the specified number Opposite of <%= after() %.

Params

* array {Array}
* n {Number}
* returns {Array}: Array excluding items after the given number.

Example

`js
<%= before(['a', 'b', 'c'], 2) %>
//=> '["a", "b"]'
`

#### after

Returns all of the items in an arry 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

`js
<%= after(['a', 'b', 'c'], 1) %>
//=> '["c"]'
`

#### each

Calling fn on each element of the given array with the given context.

Assuming that double has been registered as a helper:

Params

* array {Array}
* fn {String}: The function to call on each element in the given array.
* returns {String}

Examples

`js
function double(str) {
return str + str;
}
`

`js
<%= each(['a', 'b', 'c'], double, ctx) %>
//=> '["aa", "bb", "cc"]'
`

#### map

Returns a new array, created by calling function on each element of the given array.

Assuming that double has been registered as a helper:

Params

* array {Array}
* fn {String}: The function to call on each element in the given array.
* returns {String}

Examples

`js
function double(str) {
return str + str;
}
`

`js
<%= map(['a', 'b', 'c'], double) %>
//=> '["aa", "bb", "cc"]'
`

#### join

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

`js
<%= join(['a', 'b', 'c']) %>
//=> 'a, b, c'

<%= join(['a', 'b', 'c'], '-') %>
//=> 'a-b-c'
`

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

`js
<%= sort(["b", "a", "c"]) %>
//=> 'a,b,c'

<%= sort([{a: "zzz"}, {a: "aaa"}], "a") %>
//=> '[{"a":"aaa"},{"a":"zzz"}]'
`

#### length

Returns the length of the given array.

Params

* array {Array}
* returns {Number}: The length of the array.

Example

`js
<%= length(['a', 'b', 'c']) %>
//=> 3
`

#### compact

Returns an array with all falsey values removed.

Params

* arr {Array}
* returns {Array}

Example

`js
<%= compact([null, a, undefined, 0, false, b, c, '']) %>
//=> '["a", "b", "c"]'
`

#### difference

Return the difference between the first array and additional arrays.

Params

* array {Array}: The array to compare againts.
* arrays {Array}: One or more additional arrays.
* returns {Array}

Example

`js
<%= difference(["a", "c"], ["a", "b"]) %>
//=> '["c"]'
`

#### unique

Return an array, free of duplicate values.

Params

* array {Array}: The array to uniquify
* returns {Array}: Duplicate-free array

Example

`js
<%= unique(['a', 'b', 'c', 'c']) %
=> '["a", "b", "c"]'
`

#### union

Returns an array of unique values using strict equality for comparisons.

Params

* arr {Array}
* returns {Array}

Example

`js
<%= union(["a"], ["b"], ["c"]) %>
//=> '["a", "b", "c"]'
`

#### shuffle

Shuffle the items in an array.

Params

* arr {Array}
* returns {Array}

Example

`js
<%= shuffle(["a", "b", "c"]) %>
//=> ["c", "a", "b"]
`

$3

#### embed

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

`js
<%= embed('path/to/file.js') %>

// specify the language to use
<%= embed('path/to/file.hbs', 'html') %>
`

#### jsfiddle

Generate the HTML for a jsFiddle link with the given params

Params

* params {Object}
* returns {String}

Example

`js
<%= jsfiddle({id: '0dfk10ks', {tabs: true}}) %>
`

$3

#### any

Returns true if value exists in the given string, array
or object. See any for documentation.

Params

* value {any}
* target {any}
* options {Object}

#### filter

Filter the given array or object to contain only the matching values.

Params

* arr {Array}
* returns {Array}

Example

`js
<%= filter(['foo', 'bar', 'baz']) %>
//=> '["a", "b", "c"]'
`

$3

#### and

Returns true when both valueA and valueB are truthy.

Params

* valueA {any}
* valueB {any}
* returns {Boolean}

#### compare

Render a block when a comparison of the first and third arguments returns true.

Params

* valueA {String}
* operator {String}: The operator to use for the comparison (must be a quoted string).
* valueB {String}
* returns {Boolean}

Example

`js
<%= compare("foo", "!==", "bar") %>
`

#### find

Returns the first truthy value.

Params

* ...values {...args}
* returns {any}

#### every

Returns true when all provided values are truthy.

Params

* ...values {...any}
* returns {Boolean}

#### gt

Returns true when valueA is greater than valueB.

Params

* valueA {String}
* valueB {String}
* returns {Boolean}

#### gte

Returns true when valueA is greater than or equal to valueB.

Params

* valueA {String}
* valueB {String}
* returns {Boolean}

#### _if

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

Params

* object {Object}
* key {String}
* returns {Boolean}

#### is

Returns true when valueA equals valueB.

Params

* valueA {String}
* valueB {String}
* strict {String}
* returns {Boolean}

#### eq

Alias for is.

Params

* valueA {String}
* valueB {String}
* strict {String}
* returns {Boolean}

#### isnt

Returns true when valueA does not equal valueB.

Params

* valueA {String}
* valueB {String}
* returns {Boolean}

#### notEq

Alias for isnt.

Params

* valueA {String}
* valueB {String}
* returns {Boolean}

#### lt

Returns true when valueA is less than valueB.

Params

* valueA {String}
* valueB {String}
* returns {Boolean}

#### lte

Returns true when valueA is less than or equal to valueB.

Params

* valueA {String}
* valueB {String}
* returns {Boolean}

#### or

Returns valueA if thruthy, otherwise valueB.

Params

* valueA {any}
* valueB {any}
* returns {any}

#### some

Returns true when at least one value is truthy.

Params

* ...values {...any}
* returns {Boolean}

$3

#### exists

Return true if a file exists

Params

* filepath {String}: Path of the file to check.
* returns {Boolean}: True if the file exists

Example

`js
<%= exists("foo.js") %>
`

#### read

Read a file from the file system and inject its content

Params

* filepath {String}: Path of the file to read.
* returns {String}: Contents of the given file.

Example

`js
<%= read("foo.js") %>
`

$3

#### escapeHtml

Escape HTML characters in a string.

Params

* str {String}: String of HTML with characters to escape.
* returns {String}

Example

`js
<%= escapeHtml("foo") %>
//=> <span>foo</span>
`

#### sanitize

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

Params

* str {String}: The string of HTML to sanitize.
* returns {String}

Example

`js
<%= sanitize("foo") %>
//=> 'foo'
`

$3

#### add

Return the product of a plus b.

Params

* a {Number}
* b {Number}

Example

`js
<%= add(1, 2) %>
//=> '3'
`

#### subtract

Subtract b from a.

Params

* a {Number}
* b {Number}

Example

`js
<%= subtract(5, 2) %>
//=> '3'
`

#### divide

Divide a (the numerator) by b (the divisor).

Params

* a {Number}: the numerator.
* b {Number}: the divisor.
* returns {Number}: The quotient of a divided by b.

Example

`js
<%= divide(10, 2) %>
//=> '5'
`

#### multiply

Multiply a by b.

Params

* a {Number}
* b {Number}
* returns {Number}: The product of a times b.

Example

`js
<%= divide(10, 2) %>
//=> '5'
`

#### floor

Returns the largest integer less than or equal to the given number.

Params

* number {Number}
* returns {Number}

Example

`js
<%= floor(10.6) %>
//=> '10'
`

#### ceil

Returns the smallest integer greater than or equal to the given number.

Params

* number {Number}
* returns {Number}

Example

`js
<%= ceil(10.1) %>
//=> '11'
`

#### round

Returns the value of the given number rounded to the nearest integer.

Params

* number {Number}
* returns {Number}

Example

`js
<%= round(10.1) %>
//=> '10'

<%= round(10.5) %>
//=> '11'
`

#### sum

Returns the sum of all numbers in the given array.

Params

* number {Number}
* returns {Number}

Example

`js
<%= sum([1, 2, 3, 4, 5]) %>
//=> '15'
`

$3

#### fallback

Specify a fallback value to use when the desired value is undefined. Note that undefined variables that are _not object properties_ with throw an error.

Params

* a {any}: The desired value.
* b {any}: The fallback ("default") value
* returns {any}: Either a or b

Example

`js
// when title is undefined, use the generic site.title
<%= fallback(page.title, site.title) %>
`

#### stringify

Stringify an object using JSON.stringify().

Params

* object {Object}
* returns {String}

Example

`js
<%= stringify({a: "a"}) %>
//=> '{"a":"a"}'
`

#### parse

Parse a string into an object using JSON.parse().

Params

* str {String}: The string to parse.
* returns {Object}: The parsed object.

Example

`js
<%= parse('{"foo":"bar"}')["foo"] %>
//=> 'bar'
`

#### get

Use property paths (a.b.c) get a nested value from an object.

Params

* object {Object}
* path {String}: Dot notation for the property to get.
* returns {String}

Example

`js
<%= get({a: {b: 'c'}}, 'a.b') %>
//=> 'c'
`

#### keys

Returns an array of keys from the given object.

Params

* object {Object}
* returns {Array}: Keys from object

Example

`js
<%= keys({a: 'b', c: 'd'}) %>
//=> '["a", "c"]'
`

#### isObject

Return true if the given value is an object, and not null or an array.

Params

* value {Object}: The value to check.
* returns {Boolean}

Example

`js
<%= isObject(['a', 'b', 'c']) %>
//=> 'false'

<%= isObject({a: 'b'}) %>
//=> 'true'
`

#### isPlainObject

Return true if the given value is a plain object.

Params

* value {Object}: The value to check.
* returns {Boolean}

Example

`js
<%= isPlainObject(['a', 'b', 'c']) %>
//=> 'false'

<%= isPlainObject({a: 'b'}) %>
//=> 'true'

<%= isPlainObject(/foo/g) %>
//=> 'false'
`

#### hasOwn

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

Params

* object {Object}
* key {String}
* returns {Boolean}

#### omit

Return a copy of object exclusing the given keys.

Params

* object {Object}: Object with keys to omit.
* keys {String}: Keys to omit.
* returns {Boolean}

Example

`js
<%= omit({a: 'a', b: 'b', c: 'c'}, ['a', 'c']) %>
//=> '{b: "b"}'
`

#### forIn

Iterate over the own and inherited enumerable properties of an object, and return an object with properties that evaluate to true from the callback. Exit early by returning false.

Params

* object {Object}: Object with keys to omit.
* keys {String}: Keys to omit.
* returns {Boolean}

Example

`js
const context = { values: { a: 'b', c: 'd' } };
const str = '<% forIn(values, function(val, key) { %><%= val %><% }) %>';
const fn = _.template(str, { imports: helpers });
assert.equal(fn(context), 'bd');
`

#### forOwn

Iterate over the own enumerable properties of an object, and return an object with properties that evaluate to true from the callback. Exit early by returning false

Params

* object {Object}: Object with keys to omit.
* keys {String}: Keys to omit.
* returns {Boolean}

Example

`js
const context = { values: { a: 'b', c: 'd' } };
const str = '<% forOwn(values, function(val, key) { %><%= key %><% }) %>';
const fn = _.template(str, { imports: helpers });
console.log(fn(context)) //=> 'ac'
`

#### extend

Extend o with properties of other objects.

Params

* o {Object}: The target object. Pass an empty object to shallow clone.
* objects {Object}
* returns {Object}

#### merge

Recursively combine the properties of o with the
properties of other objects.

Params

* o {Object}: The target object. Pass an empty object to shallow clone.
* objects {Object}
* returns {Object}

$3

#### dirname

Return the dirname for the given filepath. Uses the node.js path module.

Params

* filepath {String}
* returns {String}: Returns the directory part of the file path.

Example

`js
<%= dirname("a/b/c/d") %>
//=> 'a/b/c'
`

#### basename

Return the basename for the given filepath. Uses the node.js path module.

Params

* filepath {String}
* returns {String}: Returns the basename part of the file path.

Example

`js
<%= basename("a/b/c/d.js") %>
//=> 'd.js'
`

#### filename

Returns the filename for the given filepath, excluding extension. Aliased as stem.

Params

* filepath {String}
* returns {String}: Returns the file name part of the file path.

Example

`js
<%= filename("a/b/c/d.js") %>
//=> 'd'
`

#### stem

Alias for filename.

Params

* filepath {String}
* returns {String}: Returns the file name part of the file path.

Example

`js
<%= stem("a/b/c/d.js") %>
//=> 'd'
`

#### extname

Return the file extension for the given filepath. Uses the node.js path module.

Params

* filepath {String}
* returns {String}: Returns a file extension

Example

`js
<%= extname("foo.js") %>
//=> '.js'
`

#### ext

Return the file extension for the given filepath, excluding the ..

Params

* filepath {String}
* returns {String}: Returns a file extension without dot.

Example

`js
<%= ext("foo.js") %>
//=> 'js'
`

#### resolve

Resolves the given paths to an absolute path. Uses the node.js path module.

Params

* filepath {String}
* returns {String}: Returns a resolve

Example

`js
<%= resolve('/foo/bar', './baz') %>
//=> '/foo/bar/baz'
`

#### relative

Get the relative path from file a to file b. Typically a and b would be variables passed on the context. Uses the node.js path module.

Params

* a {String}: The "from" file path.
* b {String}: The "to" file path.
* returns {String}: Returns a relative path.

Example

`js
<%= relative(a, b) %>
`

#### segments

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

Params

* filepath {String}: The file path to split into segments.
* returns {String}: Returns a single, joined file path.

Example

`js
<%= 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'
`

#### join

Join all arguments together and normalize the resulting filepath. Uses the node.js path module.

Note: there is also a join() array helper, dot notation
can be used with helpers to differentiate. Example: <%= path.join() %>.

Params

* filepaths {String}: List of file paths.
* returns {String}: Returns a single, joined file path.

Example

`js
<%= join("a", "b") %>
//=> 'a/b'
`

#### isAbsolute

Returns true if a file path is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. Uses the node.js path module.

Params

* filepath {String}
* returns {String}: Returns a resolve

Example

`js
// posix
<%= isAbsolute('/foo/bar') %>
//=> 'true'
<%= isAbsolute('qux/') %>
//=> 'false'
<%= isAbsolute('.') %>
//=> 'false'

// Windows
<%= isAbsolute('//server') %>
//=> 'true'
<%= isAbsolute('C:/foo/..') %>
//=> 'true'
<%= isAbsolute('bar\\baz') %>
//=> 'false'
<%= isAbsolute('.') %>
//=> 'false'
`

#### isRelative

Returns true if a file path is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. Uses the node.js path module.

Params

* filepath {String}
* returns {String}: Returns a resolve

Example

`js
// posix
<%= isRelative('/foo/bar') %>
//=> 'false'
<%= isRelative('qux/') %>
//=> 'true'
<%= isRelative('.') %>
//=> 'true'

// Windows
<%= isRelative('//server') %>
//=> 'false'
<%= isRelative('C:/foo/..') %>
//=> 'false'
<%= isRelative('bar\\baz') %>
//=> 'true'
<%= isRelative('.') %>
//=> 'true'
`

$3

#### camelcase

camelCase the characters in string.

Params

* string {String}: The string to camelcase.
* returns {String}

Example

`js
<%= camelcase("foo bar baz") %>
//=> 'fooBarBaz'
`

#### centerAlign

Center align the characters in a string using non-breaking spaces.

Params

* str {String}: The string to reverse.
* returns {String}: Centered string.

Example

`js
<%= centerAlign("abc") %>
`

#### chop

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

Params

* string {String}: The string to chop.
* returns {String}

Example

`js
<%= chop("_ABC_") %>
//=> 'ABC'

<%= chop("-ABC-") %>
//=> 'ABC'

<%= chop(" ABC ") %>
//=> 'ABC'
`

#### count

Count the number of occurrances of a substring within a string.

Params

* string {String}
* substring {String}
* returns {Number}: The occurances of substring in string

Example

`js
<%= count("abcabcabc", "a") %>
//=> '3'
`

#### dotcase

dot.case the characters in string.

Params

* string {String}
* returns {String}

Example

`js
<%= dotcase("a-b-c d_e") %>
//=> 'a.b.c.d.e'
`

#### ellipsis

Truncate a string to the specified length, and append it with an elipsis, ….

Params

* str {String}
* length {Number}: The desired length of the returned string.
* ch {String}: Optionally pass custom characters to append. Default is ….
* returns {String}: The truncated string.

Example

`js
<%= ellipsis("foo bar baz", 7) %>
//=> 'foo bar…'
`

#### isString

Returns true if the value is a string.

Params

* val {String}
* returns {Boolean}: True if the value is a string.

Example

`js
<%= isString('abc') %>
//=> 'true'

<%= isString(null) %>
//=> 'false'
`

#### lowercase

Lowercase the characters in the given string.

Params

* string {String}: The string to lowercase.
* returns {String}

Example

`js
<%= lowercase("ABC") %>
//=> 'abc'
`

#### pascalcase

PascalCase the characters in string.

Params

* string {String}
* returns {String}

Example

`js
<%= pascalcase("foo bar baz") %>
//=> 'FooBarBaz'
`

#### snakecase

snake_case the characters in string.

Params

* string {String}
* returns {String}

Example

`js
<%= snakecase("a-b-c d_e") %>
//=> 'a_b_c_d_e'
`

#### split

Split string by the given character.

Params

* string {String}: The string to split.
* returns {String} character: Default is ,

Example

`js
<%= split("a,b,c", ",") %>
//=> ['a', 'b', 'c']
`

#### strip

Strip substring from the given string.

Params

* substring {String|RegExp}: The string or regex pattern of the substring to remove.
* string {String}: The target string.

Example

`js
<%= strip("foo-bar", "foo-") %>
//=> 'bar'
`

#### stripIndent

Strip the indentation from a string.

Params

* string {String}: The string to strip indentation from.
* returns {String}

Example

`js
<%= stripIndent(" _ABC_") %>
//=> 'ABC'
`

#### trim

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

Params

* string {String}: The string to trim.
* returns {String}

Example

`js
<%= trim(" ABC ") %>
//=> 'ABC'
`

#### dashcase

dash-case the characters in string. This is similar to slugify, but slugify makes the string compatible to be used as a URL slug.

Params

* string {String}
* returns {String}

Example

`js
<%= dashcase("a b.c d_e") %>
//=> 'a-b-c-d-e'
`

#### pathcase

path/case the characters in string.

Params

* string {String}
* returns {String}

Example

`js
<%= pathcase("a-b-c d_e") %>
//=> 'a/b/c/d/e'
`

#### sentencecase

Sentence-case the characters in string.

Params

* string {String}
* returns {String}

Example

`js
<%= sentencecase("foo bar baz.") %>
//=> 'Foo bar baz.'
`

#### hyphenate

Replace spaces in a string with hyphens. This

Params

* string {String}
* returns {String}

Example

`js
<%= hyphenate("a b c") %>
//=> 'a-b-c'
`

#### reverse

Reverse the characters in a string.

Params

* str {String}: The string to reverse.
* returns {String}

Example

`js
<%= reverse("abc") %>
//=> 'cba'
`

#### rightAlign

Right align the characters in a string using non-breaking spaces.

Params

* str {String}: The string to reverse.
* returns {String}: Right-aligned string.

Example

`js
<%= rightAlign(str) %>
`

#### replace

Replace occurrences of a with b.

Params

* str {String}
* a {String|RegExp}: Can be a string or regexp.
* b {String}
* returns {String}

Example

`js
<%= replace("abcabc", /a/, "z") %>
//=> 'zbczbc'
`

#### titlecase

Truncate a string by removing all HTML tags and limiting the result to the specified length.

Params

* str {String}
* length {Number}: The desired length of the returned string.
* returns {String}: The truncated string.

Example

`js
<%= titlecase("big deal") %>
//=> 'foo bar'
`

#### truncate

Truncate a string by removing all HTML tags and limiting the result to the specified length.

Params

* str {String}
* length {Number}: The desired length of the returned string.
* returns {String}: The truncated string.

Example

`js
<%= truncate("foo bar baz", 7) %>
//=> 'foo bar'
`

#### uppercase

Uppercase the characters in a string.

Params

* string {String}: The string to uppercase.
* returns {String}

Example

`js
<%= uppercase("abc") %>
//=> 'ABC'
`

#### wordwrap

Wrap words to a specified width using word-wrap.

Params

* string {String}: The string with words to wrap.
* object {Options}: Options to pass to word-wrap
* returns {String}: Formatted string.

Example

`js
<%= wordwrap("a b c d e f", {width: 5, newline: '
'}) %>
//=> ' a b c
d e f'
`

Coverage

`
Statements : 94.61% ( 439/464 )
Branches : 88.37% ( 190/215 )
Functions : 96.94% ( 95/98 )
Lines : 94.42% ( 389/412 )
`

About

$3

You might also be interested in the following projects (also visit the github.com/helpers, where you can find 60+ additional standalone helpers!):

* assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
* handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
* templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage

$3

$3

Jon Schlinkert

* GitHub Profile
* Twitter Profile
* LinkedIn Profile

$3

Copyright © 2018, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.8.0, on November 24, 2018._