Awesome
stemmer
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- CLI
- Types
- Compatibility
- Related
- Contribute
- Security
- License
What is this?
This package exposes a stemming algorithm. That means it gets a certain string (typically an English word), and turns it into a shorter version (a stem), which can then be compared to other stems (of other words), to check if they are both (likely) the same term.
When should I use this?
You’re probably dealing with natural language, and know you need this, if you’re here!
Install
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install stemmer
In Deno with esm.sh
:
import {stemmer} from 'https://esm.sh/stemmer@2'
In browsers with esm.sh
:
<script type="module">
import {stemmer} from 'https://esm.sh/stemmer@2?bundle'
</script>
Use
import {stemmer} from 'stemmer'
stemmer('considerations') // => 'consider'
stemmer('detestable') // => 'detest'
stemmer('vileness') // => 'vile'
API
This package exports the identifier stemmer
.
There is no default export.
stemmer(value)
Get the stem from a given value.
value
Value to stem (string
, required).
Returns
Stem for value
(string
).
CLI
Usage: stemmer [options] <words...>
Porter Stemmer algorithm
Options:
-h, --help output usage information
-v, --version output version number
Usage:
# output stems
$ stemmer considerations
# consider
# output stems from stdin
$ echo "detestable vileness" | stemmer
# detest vile
Types
This package is fully typed with TypeScript. It exports no additional types.
Compatibility
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.
Related
stmr.c
— C APIstmr
— C CLIlancaster-stemmer
— lancaster stemming algorithmdouble-metaphone
— double metaphone algorithmsoundex-code
— soundex algorithmdice-coefficient
— sørensen–dice coefficientlevenshtein-edit-distance
— levenshtein edit distancesyllable
— syllable count of English words
Contribute
Yes please! See How to Contribute to Open Source.
Security
This package is safe.