Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
String manipulation extensions for Underscore.js javascript library.
JavaScript
branch: master

This branch is 420 commits behind epeli:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
dist
lib
test
.gitignore
README.markdown
Rakefile
package.json

README.markdown

Underscore.string

Idea: Esa-Matti Suuronen esa-matti@suuronen.org

Active maintainer: Eduard Tsech edtsech@gmail.com

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"

Node.js installation

npm package

npm install underscore.string

Standalone usage:

var _s = require('underscore.string');

Integrate with Underscore.js:

var _  = require('underscore');
_.mixin(require('underscore.string'));

String Functions

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'

chars _.chars(str)

_.chars('Hello')
=> ['H','e','l','l','o']

includes _.includes(string, substring)

Tests if string contains a substring.

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

include alias for includes

count _.count(string, substring)

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

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;'

unescapeHTML _.unescapeHTML(string)

Converts entity characters to HTML equivalents.

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

insert _.insert(string, index, substing)

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

isBlank _.isBlank(string)

_('').isBlank(); // => true
_('\n').isBlank(); // => true
_(' ').isBlank(); // => true
_('a').isBlank(); // => false

join _.join(separator, *strings)

Joins strings together with given separator

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

lines _.lines(str)

_.lines("Hello\nWorld")
=> ["Hello", "World"]

reverse

Return reversed string:

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

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

Like a array splice.

_('https://edtsech@bitbucket.org/edtsech/underscore.strings').splice(30, 7, 'epeli')
=> 'https://edtsech@bitbucket.org/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'

camelize _.camelize(string)

Converts underscored or dasherized string to a camelized one

_('-moz-transform').camelize()
=> 'MozTransform'

underscored _.underscored(string)

Converts a camelized or dasherized string into an underscored one

_(MozTransform).underscored()
=> 'moz_transform'

dasherize _.dasherize(string)

Converts a underscored or camelized string into an dasherized one

_('MozTransform').dasherize()
=> '-moz-transform'

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])

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

truncate _.truncate(string, length, truncateString)

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

_('Hello').truncate(10)
=> 'Hello'

words _.words(str, delimiter=" ")

Split string by delimiter (String or RegExp), ' ' by default.

_.words("I love you")
=> ["I","love","you"]

_.words("I_love_you", "_")
=> ["I","love","you"]

_.words("I-love-you", /-/)
=> ["I","love","you"]

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"

pad _.pad(str, length, [padStr, type])

pads the str with characters until the total string length is equal to the passed length parameter. By default, pads on the left with the space char (" "). padStr is truncated to a single character if necessary.

_.pad("1", 8)
-> "       1";

_.pad("1", 8, '0')
-> "00000001";

_.pad("1", 8, '0', 'right')
-> "10000000";

_.pad("1", 8, '0', 'both')
-> "00001000";

_.pad("1", 8, 'bleepblorp', 'both')
-> "bbbb1bbb";

lpad _.lpad(str, length, [padStr])

left-pad a string. Alias for pad(str, length, padStr, 'left')

_.lpad("1", 8, '0')
-> "00000001";

rpad _.rpad(str, length, [padStr])

right-pad a string. Alias for pad(str, length, padStr, 'right')

_.rpad("1", 8, '0')
-> "10000000";

lrpad _.lrpad(str, length, [padStr])

left/right-pad a string. Alias for pad(str, length, padStr, 'both')

_.lrpad("1", 8, '0')
-> "00001000";

center alias for lrpad

ljust alias for lpad

rjust alias for rpad

toNumber _.toNumber(string, [decimals])

Parse string to number. Returns NaN if string can't be parsed to number.

_('2.556').toNumber()
=> 3

_('2.556').toNumber(1)
=> 2.6

strRight _.strRight(string, pattern)

Searches a string from left to right for a pattern and returns a substring consisting of the characters in the string that are to the right of the pattern or all string if no match found.

_('This_is_a_test_string').strRight('_')
=> "is_a_test_string";

strRightBack _.strRightBack(string, pattern)

Searches a string from right to left for a pattern and returns a substring consisting of the characters in the string that are to the right of the pattern or all string if no match found.

_('This_is_a_test_string').strRightBack('_')
=> "string";

strLeft _.strLeft(string, pattern)

Searches a string from left to right for a pattern and returns a substring consisting of the characters in the string that are to the left of the pattern or all string if no match found.

_('This_is_a_test_string').strLeft('_')
=> "This";

strLeftBack _.strLeftBack(string, pattern)

Searches a string from right to left for a pattern and returns a substring consisting of the characters in the string that are to the left of the pattern or all string if no match found.

_('This_is_a_test_string').strLeftBack('_')
=> "This_is_a_test";

stripTags

Removes all html tags from string.

_('a <a href="#">link</a>').stripTags()
=> 'a link'
_('a <a href="#">link</a><script>alert("hello world!")</script>').stripTags()
=> 'a linkalert("hello world!")'

Roadmap

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

Changelog

1.1.6

  • Fixed reverse and truncate
  • Added isBlank, stripTags, inlude(alias for includes)
  • Added uglifier compression

1.1.5

  • Added strRight, strRightBack, strLeft, strLeftBack

1.1.4

  • Added pad, lpad, rpad, lrpad methods and aliases center, ljust, rjust
  • Integration with Underscore 1.1.6

1.1.3

  • Added methods: underscored, camelize, dasherize
  • Support newer version of npm

1.1.2

  • Created functions: lines, chars, words functions

1.0.2

  • Created integration test suite with underscore.js 1.1.4 (now it's absolutely compatible)
  • Removed 'reverse' function, because this function override underscore.js 'reverse'

Contribute

  • Fork & pull request. Don't forget about tests.
  • If you planning add some feature please create issue before.

Otherwise changes will be rejected.

Contributors list

Licence

The MIT License

Copyright (c) 2011 Eduard Tsech edtsech@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.