# dictionary-en

> English spelling dictionary

Latest version **4.0.0** (published 2023-11-03) · (MIT AND BSD) license · 0 weekly downloads

## Install

```sh
npm install dictionary-en
pnpm add dictionary-en
yarn add dictionary-en
bun add dictionary-en
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2023-11-03 |
| First published | 2020-03-01 |
| Weekly downloads | 0 |
| License | (MIT AND BSD) |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 561.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1407 |
| Author | Titus Wormer |
| Maintainers | wooorm |
| Keywords | dictionary, en, english, hunspell, myspell, spelling |

## Links

- npm: https://www.npmjs.com/package/dictionary-en
- Repository: https://github.com/wooorm/dictionaries.git#main
- Homepage: https://github.com/wooorm/dictionaries/tree/main#readme
- Issues: https://github.com/wooorm/dictionaries/issues
- Funding: https://github.com/sponsors/wooorm
- npm.io page: https://npm.io/package/dictionary-en

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 4.0.0 (latest) — 2023-11-03
- 3.2.0 — 2022-04-13
- 3.1.0 — 2021-01-05
- 3.0.1 — 2020-06-16
- 3.0.0 — 2020-03-01

## README

# dictionary-en

English spelling dictionary.

## Contents

*   [What is this?](#what-is-this)
*   [When should I use this?](#when-should-i-use-this)
*   [Install](#install)
*   [Use](#use)
*   [API](#api)
    *   [`Dictionary`](#dictionary)
*   [Examples](#examples)
*   [Compatibility](#compatibility)
*   [Security](#security)
*   [Contribute](#contribute)
*   [License](#license)

## What is this?

This is a English dictionary,
generated by [`wooorm/dictionaries`][github-dictionaries] from
[`wordlist.aspell.net`][source],
normalized and packaged so that it can be installed and used like other
dictionaries.

## When should I use this?

You can use this package when integrating with tools that perform spell checking
(such as [`nodehun`][github-nodehun] or [`nspell`][github-nspell]) or when
making such tools.

## Install

This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npm-install]:

```sh
npm install dictionary-en
```

## Use

```js
import en from 'dictionary-en'

console.log(en)
// To do: use `en` somehow
```

Yields:

```js
{aff: <Buffer>, dic: <Buffer>}
```

## API

This package exports no identifiers.
The default export is a [`Dictionary`][api-dictionary].

It exports the [TypeScript][] type
[`Dictionary`][api-dictionary].

### `Dictionary`

[Hunspell][] dictionary.

###### Fields

*   `aff` ([`Buffer`][node-buffer])
    — data for the affix file (defines the language, keyboard, flags, and more)
*   `dic` ([`Buffer`][node-buffer])
    — data for the dictionary file (contains words and flags applying to those
    words)

## Examples

See the [monorepo readme][github-dictionaries] for examples.

## Compatibility

This projects is compatible with maintained versions of Node.js.

When we cut a new major release,
we drop support for unmaintained versions of Node.
This means we try to keep the current release line,
compatible with Node.js 12.

## Security

This package is safe.

## Contribute

See the [monorepo readme][github-dictionaries] for how to contribute.

> 👉 **Note**: dictionaries are not maintained here.
> Report spelling problems upstream
> ([`wordlist.aspell.net`][source]).

## License

Dictionary and affix file:
[(MIT AND BSD)](https://github.com/wooorm/dictionaries/blob/main/dictionaries/en/license).
Rest: [MIT][file-license] © [Titus Wormer][wooorm].

[api-dictionary]: #dictionary

[file-license]: https://github.com/wooorm/dictionaries/blob/main/license

[github-dictionaries]: https://github.com/wooorm/dictionaries

[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[github-nodehun]: https://github.com/nathanjsweet/nodehun

[github-nspell]: https://github.com/wooorm/nspell

[hunspell]: https://hunspell.github.io

[node-buffer]: https://nodejs.org/api/buffer.html#buffer_buffer

[npm-install]: https://docs.npmjs.com/cli/install

[source]: http://wordlist.aspell.net/dicts/

[typescript]: https://www.typescriptlang.org

[wooorm]: https://wooorm.com

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