Get n-grams from text
Switch branches/tags
Clone or download
Latest commit 006bfc9 Aug 29, 2018

readme.md

n-gram Build Status Coverage Status

Get n-grams in JavaScript.

Installation

npm:

npm install n-gram

Usage

var nGram = require('n-gram')

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

nGram.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.
nGram.bigram(['alpha', 'bravo', 'charlie']) // [['alpha', 'bravo'], ['bravo', 'charlie']]

API

nGram(n)

Factory returning a function that converts a given value to n-grams.

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

nGram.bigram(value)

Shortcut for nGram(2).

nGram.trigram(value)

Shortcut for nGram(3).

License

MIT © Titus Wormer