Remove Words

Remove a list of words from a string.

Installation

npm install @stdlib/string-remove-words

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 );

See Also

• @stdlib/string-remove-words-cli: CLI package for use as a command-line utility.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.