Skip to main content

Interface: DictionaryInformation

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

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: cspell-types/dist/index.d.mts:570

The accent characters.

Default: "\u0300-\u0341"

adjustments?​

optional adjustments?: PatternAdjustment[]

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

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: cspell-types/dist/index.d.mts:564

The alphabet to use.

Default​

"a-zA-Z"

costs?​

optional costs?: EditCosts

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

Define edit costs.

hunspellInformation?​

optional hunspellInformation?: HunspellInformation

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

Used by dictionary authors

ignore?​

optional ignore?: string

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

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: cspell-types/dist/index.d.mts:559

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

suggestionEditCosts?​

optional suggestionEditCosts?: SuggestionCostsDefs

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

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