aspell-stream

0.1.0 • Public • Published

aspell-stream

Readable and writable stream that spell checks your text and parses aspell output to an understandable format

Usage

var aspell = require('aspell-stream');
var fs = require('fs');
 
fs.createReadStream('somefile.md')
    .pipe(aspell())
    .on('misspelling', function(err) {
        console.log(err);
    });

Or...

var spellStream = aspell()
    .on('misspelling', function(err) {
        console.log(err);
        /* {
            type: 'misspelling',
            word: 'someting',
            position: 9,
            alternatives: [
                'some',
                'something',
                'so',
                'meting',
                'so-meting',
                'smiting',
                'smarting',
                'smelting',
                'sorting',
                'meting',
                'Smetana'
            ]
        } */
    });
 
spellStream.write('there is someting wrong here');
spellStream.end();

License

MIT-licensed. See LICENSE.

Package Sidebar

Install

npm i aspell-stream

Weekly Downloads

1

Version

0.1.0

License

MIT

Last publish

Collaborators

  • rexxars