dictionary-pt
Portuguese spelling dictionary.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Examples
- Compatibility
- Security
- Contribute
- License
What is this?
This is a Portuguese dictionary,
generated by wooorm/dictionaries
from
LibreOffice/dictionaries
,
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
or nspell
) or when
making such tools.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install dictionary-pt
Use
import pt from 'dictionary-pt'
console.log(pt)
// To do: use `pt` somehow
Yields:
{aff: <Buffer>, dic: <Buffer>}
API
This package exports no identifiers.
The default export is a Dictionary
.
It exports the TypeScript type
Dictionary
.
Dictionary
Hunspell dictionary.
Fields
-
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)
Examples
See the monorepo readme 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 for how to contribute.
👉 Note: dictionaries are not maintained here. Report spelling problems upstream (
LibreOffice/dictionaries
).
License
Dictionary and affix file: (LGPL-3.0 OR MPL-2.0). Rest: MIT © Titus Wormer.