keyword-extractor
Advanced tools
Module for creating a keyword array from a string and excluding stop words.
A simple NPM package for extracting keywords from a string by removing stopwords.
$ npm install keyword-extractor
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
// include the Keyword Extractor
const keyword_extractor = require("keyword-extractor");
// Opening sentence to NY Times Article at
/*
http://www.nytimes.com/2013/09/10/world/middleeast/
surprise-russian-proposal-catches-obama-between-putin-and-house-republicans.html
*/
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 =
keyword_extractor.extract(sentence,{
language:"english",
remove_digits: true,
return_changed_case:true,
remove_duplicates: false
});
/*
extraction result is:
[
"president",
"obama",
"woke",
"monday",
"facing",
"congressional",
"defeat",
"parties",
"believed",
"hobble",
"presidency"
]
*/
The second argument of the extract method is an Object of configuration/processing settings for the extraction.
| Parameter Name | Description | Permitted Values |
|---|---|---|
| language | The stopwords list to use. ISO 639-1 codes and verbose names | ar, 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_digits | Removes all digits from the results if set to true (can handle Arabic and Perisan digits too) | true or false |
| return_changed_case | The 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_words | Instead 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_duplicates | Removes the duplicate keywords | true , false (defaults to false ) |
| return_max_ngrams | Returns keywords that are ngrams with size 0-integer | integer , false (defaults to false ) |
The initial stopwords lists are taken from the following sources:
FAQs
Module for creating a keyword array from a string and excluding stop words.
The npm package keyword-extractor receives a total of 8,127 weekly downloads. As such, keyword-extractor popularity was classified as popular.
We found that keyword-extractor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.