0.0.28 • Published 1 month ago

keyword-extractor v0.0.28

Weekly downloads
Last release
1 month ago

Keyword Extractor

Tests Status

A simple NPM package for extracting keywords from a string by removing stopwords.


$ npm install keyword-extractor

Running tests

To run the test suite, first install the development dependencies by running the following command within the package's directory.

$ npm install

To execute the package's tests, run:

$ make test

Usage of the Module

//  include the Keyword Extractor
const keyword_extractor = require("keyword-extractor");

//  Opening sentence to NY Times Article at
const sentence =
"President Obama woke up Monday facing a Congressional defeat that many in both parties believed could hobble his presidency."

//  Extract the keywords
const extraction_result =
    remove_digits: true,
    remove_duplicates: false


  extraction result is:


Options Parameters

The second argument of the extract method is an Object of configuration/processing settings for the extraction.

Parameter NameDescriptionPermitted Values
languageThe stopwords list to use. ISO 639-1 codes and verbose namesar, cs, da, de, en, es, fa, fr, gl, it, ko, nl, pl, pt, ro, ru, sv, tr, vi, arabic, czech, danish, dutch, english, french, galician,german, italian, korean, persian, polish, portuguese, romanian, russian,spanish, swedish, turkish, vietnam
remove_digitsRemoves all digits from the results if set to true (can handle Arabic and Perisan digits too)true or false
return_changed_caseThe case of the extracted keywords. Setting the value to true will return the results all lower-cased, if false the results will be in the original case.true or false
return_chained_wordsInstead of returning each word separately, join the words that were originally together. Setting the value to true will join the words, if false the results will be splitted on each array element.true or false
remove_duplicatesRemoves the duplicate keywordstrue , false (defaults to false )
return_max_ngramsReturns keywords that are ngrams with size 0-integerinteger , false (defaults to false )


The initial stopwords lists are taken from the following sources: