.. | ||
index.aff | ||
index.d.ts | ||
index.dic | ||
index.js | ||
license | ||
package.json | ||
readme.md |
dictionary-fy
Western Frisian spelling dictionary.
What is this?
This is a Western Frisian dictionary,
generated by wooorm/dictionaries
from
PanderMusubi/frisian
,
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
, nspell
) or when making such tools.
Install
In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install dictionary-fy
Use
import dictionaryFy from 'dictionary-fy'
dictionaryFy(function (error, fy) {
if (error) throw error
console.log(fy)
// To do: use `fy` somehow
})
Yields:
{dic: <Buffer>, aff: <Buffer>}
Where dic
and aff
are Buffer
s for index.dic
and index.aff
respectively.
Examples
See the monorepo readme for examples.
Types
This package is typed with TypeScript.
Contribute
See the monorepo readme for how to contribute.
👉 Note: dictionaries are not maintained here. Report spelling problems upstream (
PanderMusubi/frisian
).
License
Dictionary and affix file: GPL-3.0. Rest: MIT © Titus Wormer.