Archived

This repository has been archived on 2024-10-19. You can view files and clone it, but cannot push or open issues or pull requests.

History

KemoNine dd329205e3 start working on flyweel/ispell/hunspell		2022-04-25 14:43:48 -04:00
..
index.aff	start working on flyweel/ispell/hunspell	2022-04-25 14:43:48 -04:00
index.d.ts	start working on flyweel/ispell/hunspell	2022-04-25 14:43:48 -04:00
index.dic	start working on flyweel/ispell/hunspell	2022-04-25 14:43:48 -04:00
index.js	start working on flyweel/ispell/hunspell	2022-04-25 14:43:48 -04:00
package.json	start working on flyweel/ispell/hunspell	2022-04-25 14:43:48 -04:00
readme.md	start working on flyweel/ispell/hunspell	2022-04-25 14:43:48 -04:00

readme.md

dictionary-eu

Basque spelling dictionary.

What is this?

This is a Basque dictionary, generated by wooorm/dictionaries from xuxen.eus, 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-eu

Use

import dictionaryEu from 'dictionary-eu'

dictionaryEu(function (error, eu) {
  if (error) throw error
  console.log(eu)
  // To do: use `eu` somehow
})

Yields:

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

Where dic and aff are Buffers 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 (xuxen.eus).