Splits string into an array of its words. With no pattern, Lodash uses Unicode-aware word rules (including camelCase breaks). Part of Lodash String since 3.0.0 (stable — not deprecated).
Pass the string and options shown below. Check the return type before you chain another helper.
Call _.words. Start with this line.
_.words([string=''], [pattern])| Call | What it does |
|---|---|
_.words([string=''], [pattern]) | Primary signature. |
_.words(string) | Transform or inspect a string. |
Prefer import words from "lodash/words" when you want a smaller bundle.
_.words([string=''], [pattern])| Parameter | Description |
|---|---|
| string | Optional. The string to inspect (default '') |
| pattern | Optional. RegExp or string used to match words |
| Return Value | Description |
|---|---|
| * | Array of matched words |
Punctuation and & are skipped; letter words remain.
_.words('fred, barney, & pebbles');
// → ['fred', 'barney', 'pebbles']&.& are not words.A RegExp can keep tokens that the default rules drop.
_.words('fred, barney, & pebbles', /[^, ]+/g);
// → ['fred', 'barney', '&', 'pebbles']/[^, ]+/g matches runs that are not comma or space.& qualifies as a token.g flag finds every match.Default rules break on case changes and digit runs.
_.words('fooBar');
// → ['foo', 'Bar']
_.words('XMLHttpRequest');
// → ['XML', 'Http', 'Request']
_.words('version2Update');
// → ['version', '2', 'Update']XML stays together before Http._.kebabCase rely on this.Use the array length for a simple word count.
var text = 'Learn Lodash words today';
var parts = _.words(text);
parts.length;
// → 4
parts.join('-');
// → 'Learn-Lodash-words-today'_.words returns four words..length is the word count.join._.kebabCase for full case conversion.Empty strings return []; digit runs still count as words.
_.words('');
// → []
_.words(' ');
// → []
_.words('404 error 12');
// → ['404', 'error', '12'][], not null..length or .map._.words is a Lodash String helper (available since 3.0.0, stable in 4.x). It runs anywhere Lodash runs — modern browsers (via CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available in [email protected] full builds and the lodash/words modular import. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Safe for production once Lodash is on the page or in your bundle. Prefer import words from "lodash/words" for smaller builds. Pass a custom pattern when default Unicode/camelCase rules are not what you want.
Browse the full list of Lodash string helpers and tutorials.
10 people found this page helpful