time-to-botec/js/node_modules/@stdlib/string/remove-words/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

34 lines
706 B
Plaintext

{{alias}}( str, words[, ignoreCase] )
Removes all occurrences of the given words from a `string`.
Parameters
----------
str: string
Input string.
words: Array<string>
Array of words to be removed.
ignoreCase: boolean (optional)
Boolean indicating whether to perform a case-insensitive operation.
Default: `false`.
Returns
-------
out: string
String with words removed.
Examples
--------
> var out = {{alias}}( 'beep boop Foo bar', [ 'boop', 'foo' ] )
'beep Foo bar'
// Case-insensitive:
> out = {{alias}}( 'beep boop Foo bar', [ 'boop', 'foo' ], true )
'beep bar'
See Also
--------