Interface: DictionaryDefinitionSimple

Defined in: DictionaryDefinition.ts:132

An Empty Dictionary Definition

Extends

• DictionaryDefinitionBaseWithPathsHidden

Properties

btrie?

optional btrie: string

Defined in: DictionaryDefinition.ts:119

Hide

Inherited from

DictionaryDefinitionBaseWithPathsHidden.btrie

---

description?

optional description: string

Defined in: DictionaryDefinition.ts:31

Optional description of the contents / purpose of the dictionary.

Inherited from

DictionaryDefinitionBaseWithPathsHidden.description

---

file?

optional file: undefined

Defined in: DictionaryDefinition.ts:124

Hide

Inherited from

DictionaryDefinitionBaseWithPathsHidden.file

---

ignoreForbiddenWords?

optional ignoreForbiddenWords: boolean

Defined in: DictionaryDefinition.ts:151

Hide

Overrides

DictionaryDefinitionBaseWithPathsHidden.ignoreForbiddenWords

---

name

name: string

Defined in: DictionaryDefinition.ts:26

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: DictionaryDefinition.ts:146

Hide

Overrides

DictionaryDefinitionBaseWithPathsHidden.noSuggest

---

path?

optional path: string

Defined in: DictionaryDefinition.ts:114

Hide

Inherited from

DictionaryDefinitionBaseWithPathsHidden.path

---

repMap?

optional repMap: ReplaceMap

Defined in: DictionaryDefinition.ts:136

Hide

Overrides

DictionaryDefinitionBaseWithPathsHidden.repMap

---

supportNonStrictSearches?

optional supportNonStrictSearches: boolean

Defined in: DictionaryDefinition.ts:84

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: DictionaryDefinition.ts:156

Hide

Overrides

DictionaryDefinitionBaseWithPathsHidden.type

---

useCompounds?

optional useCompounds: boolean

Defined in: DictionaryDefinition.ts:141

Hide

Overrides

DictionaryDefinitionBaseWithPathsHidden.useCompounds