Interface: DictionaryInformation

Defined in: packages/cspell-types/dist/index.d.mts:495

Use by dictionary authors to help improve the quality of suggestions given from the dictionary.

Added with v5.16.0.

Properties

accents?

optional accents: string | CharacterSetCosts[]

Defined in: packages/cspell-types/dist/index.d.mts:511

The accent characters.

Default: "\u0300-\u0341"

---

adjustments?

optional adjustments: PatternAdjustment[]

Defined in: packages/cspell-types/dist/index.d.mts:529

A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.

---

alphabet?

optional alphabet: string | CharacterSetCosts[]

Defined in: packages/cspell-types/dist/index.d.mts:505

The alphabet to use.

Default

"a-zA-Z"

---

costs?

optional costs: EditCosts

Defined in: packages/cspell-types/dist/index.d.mts:515

Define edit costs.

---

hunspellInformation?

optional hunspellInformation: HunspellInformation

Defined in: packages/cspell-types/dist/index.d.mts:524

Used by dictionary authors

---

ignore?

optional ignore: string

Defined in: packages/cspell-types/dist/index.d.mts:538

An optional set of characters that can possibly be removed from a word before checking it.

This is useful in languages like Arabic where Harakat accents are optional.

Note: All matching characters are removed or none. Partial removal is not supported.

---

locale?

optional locale: string

Defined in: packages/cspell-types/dist/index.d.mts:500

The locale of the dictionary. Example: nl,nl-be

---

suggestionEditCosts?

optional suggestionEditCosts: SuggestionCostsDefs

Defined in: packages/cspell-types/dist/index.d.mts:520

Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.