Skip to main content

Interface: DictionaryDefinitionSimple

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

An Empty Dictionary Definition

Extends​

  • DictionaryDefinitionBaseWithPathsHidden

Properties​

btrie?​

optional btrie: string

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

Hide​

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.btrie

description?​

optional description: string

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

Optional description of the contents / purpose of the dictionary.

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.description

file?​

optional file: undefined

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

Hide​

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.file

ignoreForbiddenWords?​

optional ignoreForbiddenWords: boolean

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

Hide​

Overrides​

DictionaryDefinitionBaseWithPathsHidden.ignoreForbiddenWords

name​

name: string

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

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​

DictionaryDefinitionBaseWithPathsHidden.name

noSuggest?​

optional noSuggest: boolean

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

Hide​

Overrides​

DictionaryDefinitionBaseWithPathsHidden.noSuggest

path?​

optional path: string

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

Hide​

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.path

repMap?​

optional repMap: ReplaceMap

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

Hide​

Overrides​

DictionaryDefinitionBaseWithPathsHidden.repMap

supportNonStrictSearches?​

optional supportNonStrictSearches: boolean

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

Strip case and accents to allow for case insensitive searches and words without accents.

Note: this setting only applies to word lists. It has no-impact on trie dictionaries.

Default​

true

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.supportNonStrictSearches

type?​

optional type: DictionaryFileTypes

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

Hide​

Overrides​

DictionaryDefinitionBaseWithPathsHidden.type

useCompounds?​

optional useCompounds: boolean

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

Hide​

Overrides​

DictionaryDefinitionBaseWithPathsHidden.useCompounds