Skip to main content

Interface: DictionaryDefinitionSimple

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

An Empty Dictionary Definition

Extends​

  • DictionaryDefinitionBaseWithPathsHidden

Properties​

btrie?​

optional btrie?: string

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

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.btrie

description?​

optional description?: string

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

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

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.file

ignoreForbiddenWords?​

optional ignoreForbiddenWords?: boolean

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

Overrides​

DictionaryDefinitionBaseWithPathsHidden.ignoreForbiddenWords

kind?​

optional kind?: DictionaryKind

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

Overrides​

DictionaryDefinitionBaseWithPathsHidden.kind

name​

name: string

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

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

Overrides​

DictionaryDefinitionBaseWithPathsHidden.noSuggest

path?​

optional path?: string

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

Inherited from​

DictionaryDefinitionBaseWithPathsHidden.path

repMap?​

optional repMap?: ReplaceMap

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

Overrides​

DictionaryDefinitionBaseWithPathsHidden.repMap

supportNonStrictSearches?​

optional supportNonStrictSearches?: boolean

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

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

Overrides​

DictionaryDefinitionBaseWithPathsHidden.type

useCompounds?​

optional useCompounds?: boolean

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

Overrides​

DictionaryDefinitionBaseWithPathsHidden.useCompounds