time-to-botec/js/node_modules/@stdlib/string/remove-words/README.md

Remove Words

Remove a list of words from a string.

Usage

var removeWords = require( '@stdlib/string/remove-words' );

removeWords( str, words[, ignoreCase] )

Removes all occurrences of the given words from a string.

var str = 'beep boop Foo bar';
var out = removeWords( str, [ 'boop', 'foo' ] );
// returns 'beep  Foo bar'

By default, words are removed from an input string in case of an exact match. To perform a case-insensitive replace operation, set ignoreCase to true.

var str = 'beep boop Foo bar';
var out = removeWords( str, [ 'boop', 'foo' ], true );
// returns 'beep   bar'

Examples

var removeWords = require( '@stdlib/string/remove-words' );
var stopwords = require( '@stdlib/datasets/stopwords-en' );
var inmap = require( '@stdlib/utils/inmap' );
var spam = require( '@stdlib/datasets/spam-assassin' );

var corpus = spam();
var words = stopwords();

function remove( mail, idx ) {
    var newText = removeWords( mail.text, words );
    console.log( 'After removing stop words, email %d contains %d characters. Originally, it contained %d.', idx, newText.length, mail.text.length );
    mail.text = newText;
}

inmap( corpus, remove );

---

CLI

Usage

Usage: remove-words [options] [<string>] --words=<string>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --words w1,w2,...     Comma-separated list of words.
         --ignore-case         Perform case-insensitive replace operation.

Examples

$ remove-words 'beep! boop!!!' --words='beep,boop'
! !!!

To use as a standard stream,

$ echo -n 'beep! boop!!!' | remove-words --words='BEEP,BOOP' --ignore-case
! !!!