Skip to content

Latest commit

 

History

History
66 lines (53 loc) · 2.05 KB

README.md

File metadata and controls

66 lines (53 loc) · 2.05 KB
Raw

sw-extract

NPM

Build Status Coverage Status node-current

A simple javascript stopwords extractor with 0 dependencies. demo

Installation

NPM

npm install sw-extract --save

CDN

https://unpkg.com/sw-extract@latest/dist/sw-extract.umd.min.js

Usage with a bundler

To use sw-extract with Webpack, Parcel or other bundler

import Keywords from 'sw-extract';

const text = 'Your Text...'
const options = {...}
const result = Keywords(text, options).toArray();

Usage in Browser directly

<script src="https://unpkg.com/sw-extract@latest/dist/sw-extract.umd.min.js"></script>
<body>
  ...
</body>
<script>
  const text = 'Your Text...'
  const options = {...}
  const result = Keywords(text, options).toArray();
</script>

Using Options

{
    lang: 'en',          // Use english stopwords list (available languages: ar, en, fr)
    length: null,        // Set the length of the returned result (default return all result)
    wordLength: 3,       // Set the minimum length of the returned words (default is >= 3 chars)
    unique: true,        // Removes the duplicate keywords if set to true
    digits: false,       // Includes all digits if set to true
    toLower: false,      // Lower-cased all extracted keywords if set to true
    onlyDuplicate: false // Return only duplicated keywords if set to true
}

Credits

The Stopwords sources:

License

MIT

Use and abuse at your own risk.