Porter Stemmer algorithm
npm install stemmer[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[Porter stemming algorithm][source].
* What is this?
* When should I use this?
* Install
* Use
* API
* stemmer(value)
* CLI
* Types
* Compatibility
* Related
* Contribute
* Security
* License
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.
You’re probably dealing with natural language, and know you need this, if
you’re here!
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
``sh`
npm install stemmer
In Deno with [esm.sh][esmsh]:
`js`
import {stemmer} from 'https://esm.sh/stemmer@2'
In browsers with [esm.sh][esmsh]:
`html`
`js
import {stemmer} from 'stemmer'
stemmer('considerations') // => 'consider'
stemmer('detestable') // => 'detest'
stemmer('vileness') // => 'vile'
`
This package exports the identifier stemmer.
There is no default export.
Get the stem from a given value.
###### value
Value to stem (string, required).
##### Returns
Stem for value (string).
`txt
Usage: stemmer [options]
Porter Stemmer algorithm
Options:
-h, --help output usage information
-v, --version output version number
Usage:
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 API
* stmr
— C CLI
* lancaster-stemmer
— lancaster stemming algorithm
* double-metaphone
— double metaphone algorithm
* soundex-code
— soundex algorithm
* dice-coefficient
— sørensen–dice coefficient
* levenshtein-edit-distance
— levenshtein edit distance
* syllable`Yes please!
See [How to Contribute to Open Source][contribute].
This package is safe.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/words/stemmer/workflows/main/badge.svg
[build]: https://github.com/words/stemmer/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/words/stemmer.svg
[coverage]: https://codecov.io/github/words/stemmer
[downloads-badge]: https://img.shields.io/npm/dm/stemmer.svg
[downloads]: https://www.npmjs.com/package/stemmer
[size-badge]: https://img.shields.io/bundlephobia/minzip/stemmer.svg
[size]: https://bundlephobia.com/result?p=stemmer
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[license]: license
[author]: https://wooorm.com
[source]: https://tartarus.org/martin/PorterStemmer
[npm]: https://www.npmjs.com