String methods

String methods cover case conversion, padding and trimming, escaping, and templating. See Chain sequences for the lodash wrapper and Security before using _.template with untrusted input.

_.camelCase([string=''])

Available since v3.0.0.

Converts string to camel case.

Returns string — Returns the camel cased string.

_.camelCase('Foo Bar');
// => 'fooBar'

_.camelCase('--foo-bar--');
// => 'fooBar'

_.camelCase('__FOO_BAR__');
// => 'fooBar'

_.capitalize([string=''])

Available since v3.0.0.

Converts the first character of string to upper case and the remaining to lower case.

Returns string — Returns the capitalized string.

_.capitalize('FRED');
// => 'Fred'

_.deburr([string=''])

Available since v3.0.0.

Deburrs string by converting Latin-1 Supplement#Character_table) and Latin Extended-A letters to basic Latin letters and removing combining diacritical marks.

Returns string — Returns the deburred string.

_.deburr('déjà vu');
// => 'deja vu'

_.endsWith([string=''], [target], [position=string.length])

Available since v3.0.0.

Checks if string ends with the given target string.

Returns boolean — Returns true if string ends with target, else false.

_.endsWith('abc', 'c');
// => true

_.endsWith('abc', 'b');
// => false

_.endsWith('abc', 'b', 2);
// => true

_.escape([string=''])

Available since v0.1.0.

Converts the characters "&", "<", ">", '"', and "'" in string to their corresponding HTML entities.

Note: No other characters are escaped. To escape additional characters use a third-party library like _he_.

Though the ">" character is escaped for symmetry, characters like ">" and "/" don't need escaping in HTML and have no special meaning unless they're part of a tag or unquoted attribute value. See Mathias Bynens's article (under "semi-related fun fact") for more details.

When working with HTML you should always quote attribute values to reduce XSS vectors.

Returns string — Returns the escaped string.

_.escape('fred, barney, & pebbles');
// => 'fred, barney, & pebbles'

_.escapeRegExp([string=''])

Available since v3.0.0.

Escapes the RegExp special characters "^", "$", "\", ".", "*", "+", "?", "(", ")", "[", "]", "\{", "\}", and "|" in string.

Returns string — Returns the escaped string.

_.escapeRegExp('[lodash](https://lodash.com/)');
// => '\[lodash\]\(https://lodash\.com/\)'

_.kebabCase([string=''])

Available since v3.0.0.

Converts string to kebab case.

Returns string — Returns the kebab cased string.

_.kebabCase('Foo Bar');
// => 'foo-bar'

_.kebabCase('fooBar');
// => 'foo-bar'

_.kebabCase('__FOO_BAR__');
// => 'foo-bar'

_.lowerCase([string=''])

Available since v4.0.0.

Converts string, as space separated words, to lower case.

Returns string — Returns the lower cased string.

_.lowerCase('--Foo-Bar--');
// => 'foo bar'

_.lowerCase('fooBar');
// => 'foo bar'

_.lowerCase('__FOO_BAR__');
// => 'foo bar'

_.lowerFirst([string=''])

Available since v4.0.0.

Converts the first character of string to lower case.

Returns string — Returns the converted string.

_.lowerFirst('Fred');
// => 'fred'

_.lowerFirst('FRED');
// => 'fRED'

_.pad([string=''], [length=0], [chars=' '])

Available since v3.0.0.

Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.

Returns string — Returns the padded string.

_.pad('abc', 8);
// => '  abc   '

_.pad('abc', 8, '_-');
// => '_-abc_-_'

_.pad('abc', 3);
// => 'abc'

_.padEnd([string=''], [length=0], [chars=' '])

Available since v4.0.0.

Pads string on the right side if it's shorter than length. Padding characters are truncated if they exceed length.

Returns string — Returns the padded string.

_.padEnd('abc', 6);
// => 'abc   '

_.padEnd('abc', 6, '_-');
// => 'abc_-_'

_.padEnd('abc', 3);
// => 'abc'

_.padStart([string=''], [length=0], [chars=' '])

Available since v4.0.0.

Pads string on the left side if it's shorter than length. Padding characters are truncated if they exceed length.

Returns string — Returns the padded string.

_.padStart('abc', 6);
// => '   abc'

_.padStart('abc', 6, '_-');
// => '_-_abc'

_.padStart('abc', 3);
// => 'abc'

_.parseInt(string, [radix=10])

Available since v1.1.0.

Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used unless value is a hexadecimal, in which case a radix of 16 is used.

Note: This method aligns with the ES5 implementation of parseInt.

Returns number — Returns the converted integer.

_.parseInt('08');
// => 8

_.map(['6', '08', '10'], _.parseInt);
// => [6, 8, 10]

_.repeat([string=''], [n=1])

Available since v3.0.0.

Repeats the given string n times.

Returns string — Returns the repeated string.

_.repeat('*', 3);
// => '***'

_.repeat('abc', 2);
// => 'abcabc'

_.repeat('abc', 0);
// => ''

_.replace([string=''], pattern, replacement)

Available since v4.0.0.

Replaces matches for pattern in string with replacement.

Note: This method is based on String#replace.

Returns string — Returns the modified string.

_.replace('Hi Fred', 'Fred', 'Barney');
// => 'Hi Barney'

_.snakeCase([string=''])

Available since v3.0.0.

Converts string to snake case.

Returns string — Returns the snake cased string.

_.snakeCase('Foo Bar');
// => 'foo_bar'

_.snakeCase('fooBar');
// => 'foo_bar'

_.snakeCase('--FOO-BAR--');
// => 'foo_bar'

_.split([string=''], separator, [limit])

Available since v4.0.0.

Splits string by separator.

Note: This method is based on String#split.

Returns Array — Returns the string segments.

_.split('a-b-c', '-', 2);
// => ['a', 'b']

_.startCase([string=''])

Available since v3.1.0.

Converts string to start case.

Returns string — Returns the start cased string.

_.startCase('--foo-bar--');
// => 'Foo Bar'

_.startCase('fooBar');
// => 'Foo Bar'

_.startCase('__FOO_BAR__');
// => 'FOO BAR'

// Numbers are treated as separate words.
_.startCase('abc123def');
// => 'Abc 123 Def'

_.startsWith([string=''], [target], [position=0])

Available since v3.0.0.

Checks if string starts with the given target string.

Returns boolean — Returns true if string starts with target, else false.

_.startsWith('abc', 'a');
// => true

_.startsWith('abc', 'b');
// => false

_.startsWith('abc', 'b', 1);
// => true

_.template([string=''], [options={}])

Available since v0.1.0.

Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is given, it takes precedence over _.templateSettings values.

Security: _.template is insecure and should not be used. It will be removed in Lodash v5. Avoid untrusted input. See threat model.

Note: In the development build _.template utilizes sourceURLs for easier debugging.

For more information on precompiling templates see lodash's custom builds documentation.

For more information on Chrome extension sandboxes see Chrome's extensions documentation.

Returns Function — Returns the compiled template function.

// Use the "interpolate" delimiter to create a compiled template.
var compiled = _.template('hello <%= user %>!');
compiled({ 'user': 'fred' });
// => 'hello fred!'

// Use the HTML "escape" delimiter to escape data property values.
var compiled = _.template('<b><%- value %></b>');
compiled({ 'value': '<script>' });
// => '<b>&lt;script&gt;</b>'

// Use the "evaluate" delimiter to execute JavaScript and generate HTML.
var compiled = _.template('<% _.forEach(users, function(user) { %><li><%- user %></li><% }); %>');
compiled({ 'users': ['fred', 'barney'] });
// => '<li>fred</li><li>barney</li>'

// Use the internal `print` function in "evaluate" delimiters.
var compiled = _.template('<% print("hello " + user); %>!');
compiled({ 'user': 'barney' });
// => 'hello barney!'

// Use the ES template literal delimiter as an "interpolate" delimiter.
// Disable support by replacing the "interpolate" delimiter.
var compiled = _.template('hello ${ user }!');
compiled({ 'user': 'pebbles' });
// => 'hello pebbles!'

// Use backslashes to treat delimiters as plain text.
var compiled = _.template('<%= "\\<%- value %\\>" %>');
compiled({ 'value': 'ignored' });
// => '<%- value %>'

// Use the `imports` option to import `jQuery` as `jq`.
var text = '<% jq.each(users, function(user) { %><li><%- user %></li><% }); %>';
var compiled = _.template(text, { 'imports': { 'jq': jQuery } });
compiled({ 'users': ['fred', 'barney'] });
// => '<li>fred</li><li>barney</li>'

// Use the `sourceURL` option to specify a custom sourceURL for the template.
var compiled = _.template('hello <%= user %>!', { 'sourceURL': '/basic/greeting.jst' });
compiled(data);
// => Find the source of "greeting.jst" under the Sources tab or Resources panel of the web inspector.

// Use the `variable` option to ensure a with-statement isn't used in the compiled template.
var compiled = _.template('hi <%= data.user %>!', { 'variable': 'data' });
compiled.source;
// => function(data) {
//   var __t, __p = '';
//   __p += 'hi ' + ((__t = ( data.user )) == null ? '' : __t) + '!';
//   return __p;
// }

// Use custom template delimiters.
_.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
var compiled = _.template('hello {{ user }}!');
compiled({ 'user': 'mustache' });
// => 'hello mustache!'

// Use the `source` property to inline compiled templates for meaningful
// line numbers in error messages and stack traces.
fs.writeFileSync(path.join(process.cwd(), 'jst.js'), '\
  var JST = {\
    "main": ' + _.template(mainText).source + '\
  };\
');

_.toLower([string=''])

Available since v4.0.0.

Converts string, as a whole, to lower case just like String#toLowerCase.

Returns string — Returns the lower cased string.

_.toLower('--Foo-Bar--');
// => '--foo-bar--'

_.toLower('fooBar');
// => 'foobar'

_.toLower('__FOO_BAR__');
// => '__foo_bar__'

_.toUpper([string=''])

Available since v4.0.0.

Converts string, as a whole, to upper case just like String#toUpperCase.

Returns string — Returns the upper cased string.

_.toUpper('--foo-bar--');
// => '--FOO-BAR--'

_.toUpper('fooBar');
// => 'FOOBAR'

_.toUpper('__foo_bar__');
// => '__FOO_BAR__'

_.trim([string=''], [chars=whitespace])

Available since v3.0.0.

Removes leading and trailing whitespace or specified characters from string.

Returns string — Returns the trimmed string.

_.trim('  abc  ');
// => 'abc'

_.trim('-_-abc-_-', '_-');
// => 'abc'

_.map(['  foo  ', '  bar  '], _.trim);
// => ['foo', 'bar']

_.trimEnd([string=''], [chars=whitespace])

Available since v4.0.0.

Removes trailing whitespace or specified characters from string.

Returns string — Returns the trimmed string.

_.trimEnd('  abc  ');
// => '  abc'

_.trimEnd('-_-abc-_-', '_-');
// => '-_-abc'

_.trimStart([string=''], [chars=whitespace])

Available since v4.0.0.

Removes leading whitespace or specified characters from string.

Returns string — Returns the trimmed string.

_.trimStart('  abc  ');
// => 'abc  '

_.trimStart('-_-abc-_-', '_-');
// => 'abc-_-'

_.truncate([string=''], [options={}])

Available since v4.0.0.

Truncates string if it's longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "...".

Returns string — Returns the truncated string.

_.truncate('hi-diddly-ho there, neighborino');
// => 'hi-diddly-ho there, neighbo...'

_.truncate('hi-diddly-ho there, neighborino', {
  'length': 24,
  'separator': ' '
});
// => 'hi-diddly-ho there,...'

_.truncate('hi-diddly-ho there, neighborino', {
  'length': 24,
  'separator': /,? +/
});
// => 'hi-diddly-ho there...'

_.truncate('hi-diddly-ho there, neighborino', {
  'omission': ' [...]'
});
// => 'hi-diddly-ho there, neig [...]'

_.unescape([string=''])

Available since v0.6.0.

The inverse of _.escape; this method converts the HTML entities &, <, >, ", and ' in string to their corresponding characters.

Note: No other HTML entities are unescaped. To unescape additional HTML entities use a third-party library like _he_.

Returns string — Returns the unescaped string.

_.unescape('fred, barney, & pebbles');
// => 'fred, barney, & pebbles'

_.upperCase([string=''])

Available since v4.0.0.

Converts string, as space separated words, to upper case.

Returns string — Returns the upper cased string.

_.upperCase('--foo-bar');
// => 'FOO BAR'

_.upperCase('fooBar');
// => 'FOO BAR'

_.upperCase('__foo_bar__');
// => 'FOO BAR'

_.upperFirst([string=''])

Available since v4.0.0.

Converts the first character of string to upper case.

Returns string — Returns the converted string.

_.upperFirst('fred');
// => 'Fred'

_.upperFirst('FRED');
// => 'FRED'

_.words([string=''], [pattern])

Available since v3.0.0.

Splits string into an array of its words.

Returns Array — Returns the words of string.

_.words('fred, barney, & pebbles');
// => ['fred', 'barney', 'pebbles']

_.words('fred, barney, & pebbles', /[^, ]+/g);
// => ['fred', 'barney', '&', 'pebbles']