Skip to main content

Function: words()

Call Signature​

words(str, options?): string[]

Defined in: string/extract/index.ts:42

Splits a string into an array of words.

By default, splits on non-alphanumeric characters. Custom pattern can be provided.

Parameters​

str​

string

The string to split

options?​

WordsOptions

Options for word splitting

Returns​

string[]

Array of words

Example​

// Data-first
words('hello world')
// => ['hello', 'world']

words('user-profile-page')
// => ['user', 'profile', 'page']

words('oneTwo three_four')
// => ['oneTwo', 'three', 'four']

words('hello, world!')
// => ['hello', 'world']

// Data-last (in pipe)
pipe(
  'The quick brown fox',
  words,
  R.map(capitalize)
)
// => ['The', 'Quick', 'Brown', 'Fox']

See​

  • lines - to split by line breaks
  • between - to extract text between delimiters

Call Signature​

words(options): (str) => string[]

Defined in: string/extract/index.ts:43

Splits a string into an array of words.

By default, splits on non-alphanumeric characters. Custom pattern can be provided.

Parameters​

options​

WordsOptions

Options for word splitting

Returns​

Array of words

(str): string[]

Parameters​

str​

string

Returns​

string[]

Example​

// Data-first
words('hello world')
// => ['hello', 'world']

words('user-profile-page')
// => ['user', 'profile', 'page']

words('oneTwo three_four')
// => ['oneTwo', 'three', 'four']

words('hello, world!')
// => ['hello', 'world']

// Data-last (in pipe)
pipe(
  'The quick brown fox',
  words,
  R.map(capitalize)
)
// => ['The', 'Quick', 'Brown', 'Fox']

See​

  • lines - to split by line breaks
  • between - to extract text between delimiters