ngraminator

    3.0.1 • Public • Published

    ngraminator

    A really small ngram generator for Node.js and the browser. Check out the interactive demo.

    NPM version NPM downloads Build Status JavaScript Style Guide MIT License

    Breaking change

    How the library is now required is slightly different. For CommonJS it used to be const ngraminator = require('ngraminator'), but now it is const { ngraminator } = require('ngraminator')

    And UMD used to be ngraminator(), but is now ngrm.ngraminator()

    Demo at work

    Initiation

    CJS - CommonJS

    const { ngraminator } = require('ngraminator')
    // ngraminator(wordArray, ngramLenghtArray) available

    ESM - Ecmascript Modules

    import { ngraminator } from 'ngraminator'
    // ngraminator(wordArray, ngramLenghtArray) available

    Script tag

    <script src="ngraminator.umd.js"></script>
    
    <script>
    // ngrm.ngraminator(wordArray, ngramLenghtArray) available
    </script>

    Usage

    const str = "mary had a little lamb it's fleece"
    
    // get ngrams of length 3
    ngraminator(str.split(' '), [3])
    // [
    //   ['mary', 'had', 'a'],
    //   ['had', 'a', 'little'],
    //   ['a', 'little', 'lamb'],
    //   ['little', 'lamb', 'it\'s'],
    //   ['lamb', 'it\'s', 'fleece']
    // ]
    
    // get ngrams of lengths 1 and 2
    ngraminator(str.split(' '), [1, 2])
    // [
    //   [ 'mary' ],
    //   [ 'had' ],
    //   [ 'a' ],
    //   [ 'little' ],
    //   [ 'lamb' ],
    //   [ 'it\'s' ],
    //   [ 'fleece' ],
    //   [ 'mary', 'had' ],
    //   [ 'had', 'a' ],
    //   [ 'a', 'little' ],
    //   [ 'little', 'lamb' ],
    //   [ 'lamb', 'it\'s' ],
    //   [ 'it\'s', 'fleece' ]
    // ]
    
    // get ngrams of lengths 1, 2, and 5
    ngraminator(str.split(' '), [1, 2, 5])
    // [
    //   [ 'a' ],
    //   [ 'a', 'little' ],
    //   [ 'a', 'little', 'lamb', 'it\'s', 'fleece' ],
    //   [ 'fleece' ],
    //   [ 'had' ],
    //   [ 'had', 'a' ],
    //   [ 'had', 'a', 'little', 'lamb', 'it\'s' ],
    //   [ 'it\'s' ],
    //   [ 'it\'s', 'fleece' ],
    //   [ 'lamb' ],
    //   [ 'lamb', 'it\'s' ],
    //   [ 'little' ],
    //   [ 'little', 'lamb' ],
    //   [ 'mary' ],
    //   [ 'mary', 'had' ],
    //   [ 'mary', 'had', 'a', 'little', 'lamb' ]
    // ]
    //
    
    // get ngrams of lengths 1, 2, and 5 stringified
    ngraminator(str.split(' '), [1, 2, 5]).map(item => item.join(' '))
    // [
    //   "a",
    //   "a little",
    //   "a little lamb it's fleece",
    //   "fleece",
    //   "had",
    //   "had a",
    //   "had a little lamb it's",
    //   "it's",
    //   "it's fleece",
    //   "lamb",
    //   "lamb it's",
    //   "little",
    //   "little lamb",
    //   "mary",
    //   "mary had",
    //   "mary had a little lamb"
    // ]
    //

    Keywords

    none

    Install

    npm i ngraminator

    DownloadsWeekly Downloads

    114

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    67.4 kB

    Total Files

    21

    Last publish

    Collaborators

    • fergie
    • eklem