https://github.com/rexxars/aspell-stream

Readable and writable stream that spell checks your text and parses aspell output to an understandable format
https://github.com/rexxars/aspell-stream

Last synced: 16 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rexxars/aspell-stream
• Owner: rexxars
• License: mit
• Created: 2014-06-24T12:56:15.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-03-22T16:38:22.000Z (over 5 years ago)
• Last Synced: 2024-10-17T07:12:13.815Z (27 days ago)
• Language: JavaScript
• Size: 163 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
aspell-stream

=============

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

Installation

============

Make sure `aspell` is installed on your system (`apt-get install aspell` on debian-based systems).

Run `npm install --save aspell-stream` to include it in your project.

Usage

=====

```js

var aspell = require('aspell-stream');

var fs = require('fs');

fs.createReadStream('somefile.md')

    .pipe(aspell())

    .on('misspelling', function(err) {

        console.log(err);

    });

```

Or...

```js

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.