Persian spelling dictionary.
- What is this?
- When should I use this?
- Install
- Use
- API
- Examples
- Compatibility
- Security
- Contribute
- License
This is a Persian dictionary,
generated by wooorm/dictionaries
from
b00f/lilak
,
normalized and packaged so that it can be installed and used like other
dictionaries.
You can use this package when integrating with tools that perform spell checking
(such as nodehun
or nspell
) or when
making such tools.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install dictionary-fa
import fa from 'dictionary-fa'
console.log(fa)
// To do: use `fa` somehow
Yields:
{aff: <Buffer>, dic: <Buffer>}
This package exports no identifiers.
The default export is a Dictionary
.
It exports the TypeScript type
Dictionary
.
Hunspell dictionary.
aff
(Buffer
) — data for the affix file (defines the language, keyboard, flags, and more)dic
(Buffer
) — data for the dictionary file (contains words and flags applying to those words)
See the monorepo readme for examples.
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 16.
This package is safe.
See the monorepo readme for how to contribute.
👉 Note: dictionaries are not maintained here. Report spelling problems upstream (
b00f/lilak
).
Dictionary and affix file: Apache-2.0. Rest: MIT © Titus Wormer.