# aspell-stream

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

Latest version **0.1.0** (published 2014-07-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install aspell-stream
pnpm add aspell-stream
yarn add aspell-stream
bun add aspell-stream
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-07-09 |
| First published | 2014-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Espen Hovlandsdal |
| Maintainers | rexxars |
| Keywords | aspell, spellcheck, spelling |

## Links

- npm: https://www.npmjs.com/package/aspell-stream
- Repository: https://github.com/rexxars/aspell-stream
- Issues: https://github.com/rexxars/aspell-stream/issues
- npm.io page: https://npm.io/package/aspell-stream

## Dependencies (6)

- [split](https://npm.io/package/split.md) ^0.3.0
- [plexer](https://npm.io/package/plexer.md) 0.0.3
- [duplexer](https://npm.io/package/duplexer.md) ^0.1.1
- [through2](https://npm.io/package/through2.md) ^0.5.1
- [shell-escape](https://npm.io/package/shell-escape.md) ^0.1.0
- [to-slug-case](https://npm.io/package/to-slug-case.md) ^0.1.2

## Recent versions

- 0.1.0 (latest) — 2014-07-09

## README

aspell-stream
=============

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

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.

---
_Source: https://npm.io/package/aspell-stream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._