dictionary-en-za - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

index.d.ts

package.json

		{
		"name": "dictionary-en-za",
		"version": "2.1.0",
		"description": "English (South Africa) spelling dictionary in UTF-8",
		"version": "2.2.0",
		"description": "English (South Africa) spelling dictionary",
		"license": "LGPL-2.1",
		@@ -31,4 +31,5 @@ "keywords": [
		"index.aff",
		"index.dic"
		"index.dic",
		"index.d.ts"
		]
		}

readme.md

		# dictionary-en-za

		English (South Africa) spelling dictionary in UTF-8.
		English (South Africa) spelling dictionary.

		Useful with [hunspell][], [`nodehun`][nodehun], [`nspell`][nspell],
		Open Office, LibreOffice, Firefox and Thunderbird, or [macOS][].
		## What is this?

		Generated by [`dictionaries`][dictionaries] from
		[`extensions.openoffice.org`][source].
		This is a English (South Africa) dictionary,
		generated by [`wooorm/dictionaries`][dictionaries] from
		[`extensions.openoffice.org`][source],
		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`][nodehun], [`nspell`][nspell]) or when making such tools.

		## Install

		[npm][]:
		In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:

		@@ -22,6 +29,8 @@ ```sh
		```js
		var enZa = require('dictionary-en-za')
		import dictionaryEnZa from 'dictionary-en-za'

		enZa(function (err, result) {
		console.log(err \|\| result)
		dictionaryEnZa(function (error, enZa) {
		if (error) throw error
		console.log(enZa)
		// To do: use `enZa` somehow
		})
		@@ -36,16 +45,20 @@ ```

		Where `dic` is a [`Buffer`][buffer] for the dictionary file at `index.dic` (in
		UTF-8) and `aff` is a [`Buffer`][buffer] for the affix file at `index.aff` (in
		UTF-8).
		Where `dic` and `aff` are [`Buffer`][buffer]s for `index.dic` and `index.aff`
		respectively.

		Or directly load the files, using something like:
		## Examples

		```js
		var path = require('path')
		var base = require.resolve('dictionary-en-za')
		See the [monorepo readme][dictionaries] for examples.

		fs.readFileSync(path.join(base, 'index.dic'), 'utf-8')
		fs.readFileSync(path.join(base, 'index.aff'), 'utf-8')
		```
		## Types

		This package is typed with [TypeScript][].

		## Contribute

		See the [monorepo readme][dictionaries] for how to contribute.

		> 👉 Note: dictionaries are not maintained here.
		> Report spelling problems upstream ([`extensions.openoffice.org`][source]).

		## License
		@@ -62,3 +75,3 @@

		[macos]: https://github.com/wooorm/dictionaries#macos
		[macos]: https://github.com/wooorm/dictionaries#example-use-with-macos

		@@ -76,1 +89,3 @@ [source]: http://extensions.openoffice.org/en/project/english-dictionaries-apache-openoffice
		[home]: https://wooorm.com

		[typescript]: https://www.typescriptlang.org

dictionary-en-za - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics