Skip to main content

Interface: DictionaryInformation

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

Provides extra information about the dictionary.

It is used to improve suggestions and casing rules.

Added with v5.16.0.

Properties​

accents?​

optional accents?: string | CharacterSetCosts[]

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

The accent characters.

Default: "\u0300-\u0341"

adjustments?​

optional adjustments?: PatternAdjustment[]

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

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:559

The alphabet to use.

Default​

"a-zA-Z"

costs?​

optional costs?: EditCosts

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

Define edit costs.

hunspellInformation?​

optional hunspellInformation?: HunspellInformation

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

Used by dictionary authors

ignore?​

optional ignore?: string

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

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:554

The locale of the dictionary.

The locale should follow the IETF BCP 47 standard. If more than one locale is specified, the first valid locale will be used for casing rules.

Avoid mixing different locales in the same dictionary.

Example: nl or nl-BE

suggestionEditCosts?​

optional suggestionEditCosts?: SuggestionCostsDefs

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

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