n-gram

n-gram

Get n-grams.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install n-gram

Use

import {bigram, trigram, nGram} = require('n-gram')

bigram('n-gram') // ['n-', '-g', 'gr', 'ra', 'am']
nGram(2)('n-gram') // ['n-', '-g', 'gr', 'ra', 'am']

trigram('n-gram') // ['n-g', '-gr', 'gra', 'ram']

nGram(6)('n-gram') // ['n-gram']
nGram(7)('n-gram') // []

// Anything with a `.length` and `.slice` works: arrays too.
bigram(['alpha', 'bravo', 'charlie']) // [['alpha', 'bravo'], ['bravo', 'charlie']]

API

This package exports the following identifiers: ngram, bigram, and trigram. There is no default export.

nGram(n)

Create a function that converts a given value to n-grams.

Want padding? Use something like the following: nGram(2)(' ' + value + ' ');

bigram(value)

Shortcut for nGram(2).

trigram(value)

Shortcut for nGram(3).

License

MIT © Titus Wormer