lancaster-stemmer

Lancaster stemming algorithm.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • lancasterStemmer(value)
• 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 lancaster-stemmer

In Deno with esm.sh:

import {lancasterStemmer} from 'https://esm.sh/lancaster-stemmer@2'

In browsers with esm.sh:

<script type="module">
  import {lancasterStemmer} from 'https://esm.sh/lancaster-stemmer@2?bundle'
</script>

Use

import {lancasterStemmer} from 'lancaster-stemmer'

lancasterStemmer('considerations') // => 'consid'
lancasterStemmer('detestable') // => 'detest'
lancasterStemmer('vileness') // => 'vil'
lancasterStemmer('giggling') // => 'giggl'
lancasterStemmer('anxious') // => 'anxy'

// Case insensitive
lancasterStemmer('analytic') === lancasterStemmer('AnAlYtIc') // => true

API

This package exports the identifier lancasterStemmer. There is no default export.

lancasterStemmer(value)

Get the stem from a given value.

value

Value to stem (string, required).

Returns

Stem for value (string).

CLI

Usage: lancaster-stemmer [options] <words...>

Lancaster stemming algorithm

Options:

  -h, --help           output usage information
  -v, --version        output version number

Usage:

# output stems
$ lancaster-stemmer considerations
consid

# output stems from stdin
$ echo "detestable vileness" | lancaster-stemmer
detest vil

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

• stemmer — porter stemmer algorithm
• double-metaphone — double metaphone algorithm
• soundex-code — soundex algorithm
• dice-coefficient — sørensen–dice coefficient
• levenshtein-edit-distance — levenshtein edit distance
• syllable — syllable count of English words

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Titus Wormer