underscore.string

What is underscore.string?

The underscore.string npm package provides utility functions for string manipulation, including functions for trimming, padding, converting case, and more. It extends the functionality of Underscore.js, a JavaScript library that provides functional programming helpers, to work with strings.

What are underscore.string's main functionalities?

String Trimming

Removes whitespace from both ends of a string.

" Hello world! ".trim(); // 'Hello world!'

Case Conversion

Converts dash or underscore delimited strings into camelCase.

_.str.camelize('moz-transform'); // 'mozTransform'

String Padding

Pads the string with characters until the total string length is equal to the passed length parameter.

_.str.pad('1', 8, '0'); // '00000001'

String Truncation

Truncates the string securely, not cutting words in half, and appending an ellipsis if the string was truncated.

_.str.prune('Hello, world', 5); // 'Hello...'

Number Formatting

Formats a number with grouped thousands and a specific number of decimal places.

_.str.numberFormat(1000, 2); // '1,000.00'

Other packages similar to underscore.string

lodash

Lodash is a popular utility library that offers similar string manipulation functions, along with a wide range of other utilities for arrays, objects, and more. It is often considered a more comprehensive alternative to underscore.string.

string

The 'string' npm package provides an additional set of string manipulation tools. It includes methods for creating slugs, translating to different cases, and more. It is similar to underscore.string but with a different API design and additional features.

he

The 'he' package is an HTML entity encoder/decoder. While it is more specialized than underscore.string, it offers robust handling of HTML entities which might be useful in conjunction with string manipulation.

README

Underscore.strings

Idea: Esa-Matti Suuronen (esa-matti aet suuronen dot org)

Authors: Esa-Matti Suuronen, Edward Tsech

Javascript lacks complete string manipulation operations. This an attempt to fill that cap. List of buildin methods can be found for example from Dive Into JavaScript.

As name states this an extension for Underscore.js, but it can be used independently from _s-global variable. But with Underscore.js you can use Object-Oriented style and chaining:

_("   epeli  ").chain().trim().capitalize().value()
=> "Epeli"

String Functions

blank _.blank(string)

Checks if the string is empty or contains whitespaces only.

_.blank(' ')
=> true

capitalize _.capitalize(string)

Converts first letter of the string to uppercase.

_.capitalize("epeli")
=> "Epeli"

chop _.chop(string, step)

_.chop('whitespace', 3)
=> ['whi','tes','pac','e']

clean _.clean(str)

Compress some whitespaces to one.

_.clean(" foo    bar   ")
=> 'foo bar'

contains _.contains(string, substring)

Tests if string contains a substring.

_.contains("foobar", "ob")
=> true

count _.count(string, substring)

_('Hello world').count('l')
=> 3

empty _.empty(string)

_('').empty()
=> true

escapeHTML _.escapeHTML(string)

Converts HTML special characters to their entity equivalents.

_('<div>Blah blah blah</div>').escapeHTML();
=> '&lt;div&gt;Blah blah blah&lt;/div&gt;'

includes alias for contains.

insert _.insert(string, index, substing)

_('Hello ').insert(6, 'world')
=> 'Hello world'

join _.join(separator, *strings)

Joins strings together with given separator

_.join(" ", "foo", "bar")
=> "foo bar"

reverse _.reverse(string)

Reverses the string.

_.reverse("foobar")
=> "raboof"

splice _.splice(string, index, howmany, substring)

Like a array splice.

_('https://[e-mail]/edtsech/underscore.strings').splice(30, 7, 'epeli')
=> 'https://[e-mail]/epeli/underscore.strings'

startsWith _.startsWith(string, starts)

This method checks whether string starts with starts.

_("image.gif").startsWith("image")
=> true

endsWith _.endsWith(string, ends)

This method checks whether string ends with ends.

_("image.gif").endsWith("gif")
=> true

succ _.succ(str)

Returns the successor to str.

_('a').succ()
=> 'b'

_('A').succ()
=> 'B'

supplant

Supplant function was removed, use Underscore.js template function.

strip alias for trim

lstrip alias for ltrim

rstrip alias for rtrim

titleize _.titleize(string)

_('my name is epeli').titleize()
=> 'My Name Is Epeli'

trim _.trim(string, [characters])

trims defined characters from begining and ending of the string. Defaults to whitespace characters.

_.trim("  foobar   ")
=> "foobar"

_.trim("_-foobar-_", "_-")
=> "foobar"

ltrim _.ltrim(string, [characters])

Left trim. Similar to trim, but only for left side.

rtrim _.rtrim(string, [characters])

Left trim. Similar to trim, but only for right side.

truncate _.truncate(string, length, truncateString)

_('Hello world').truncate(5)
=> 'Hello...'

sprintf _.sprintf(string format, *arguments)

C like string formatting. Credits goes to Alexandru Marasteanu. For more detailed documentation, see the original page.

_.sprintf("%.1f", 1.17)
"1.2"

Any suggestions or bug reports are welcome. Just email me or more preferably open an issue.