Skip to main content

Interface: DictionaryDefinitionAugmented

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

Used to provide extra data related to the dictionary

Extends​

Properties​

description?​

optional description: string

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

Optional description of the contents / purpose of the dictionary.

Inherited from​

DictionaryDefinitionPreferred.description

dictionaryInformation?​

optional dictionaryInformation: DictionaryInformation

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

ignoreForbiddenWords?​

optional ignoreForbiddenWords: boolean

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

Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.

Inherited from​

DictionaryDefinitionPreferred.ignoreForbiddenWords

name​

name: string

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

This is the name of a dictionary.

Name Format:

  • Must contain at least 1 number or letter.
  • Spaces are allowed.
  • Leading and trailing space will be removed.
  • Names ARE case-sensitive.
  • Must not contain *, !, ;, ,, {, }, [, ], ~.

Inherited from​

DictionaryDefinitionPreferred.name

noSuggest?​

optional noSuggest: boolean

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

Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.

Note: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.

Inherited from​

DictionaryDefinitionPreferred.noSuggest

path​

path: string

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

Path to the file.

Inherited from​

DictionaryDefinitionPreferred.path

repMap?​

optional repMap: ReplaceMap

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

Replacement pairs.

Inherited from​

DictionaryDefinitionPreferred.repMap

type?​

optional type: DictionaryFileTypes

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

Type of file:

  • S - single word per line,
  • W - each line can contain one or more words separated by space,
  • C - each line is treated like code (Camel Case is allowed).

Default is S.

C is the slowest to load due to the need to split each line based upon code splitting rules.

Note: this settings does not apply to inline dictionaries or .trie files.

Default​

"S"

Inherited from​

DictionaryDefinitionPreferred.type

useCompounds?​

optional useCompounds: boolean

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

Use Compounds.

Inherited from​

DictionaryDefinitionPreferred.useCompounds