Package Exports
- dictionary-en-gb
- dictionary-en-gb/index.aff
- dictionary-en-gb/index.dic
- dictionary-en-gb/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dictionary-en-gb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
dictionary-en-gb
English (United Kingdom) spelling dictionary.
What is this?
This is a English (United Kingdom) dictionary,
generated by wooorm/dictionaries
from
wordlist.aspell.net
,
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-en-gb
Use
import dictionaryEnGb from 'dictionary-en-gb'
dictionaryEnGb(function (error, enGb) {
if (error) throw error
console.log(enGb)
// To do: use `enGb` 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 (
wordlist.aspell.net
).
License
Dictionary and affix file: (MIT AND BSD). Rest: MIT © Titus Wormer.