Interface: SpellingDictionaryCollection

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionaryCollection.d.ts:2

Extends

• SpellingDictionary

Properties

containsNoSuggestWords

readonly containsNoSuggestWords: boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:98

Inherited from

SpellingDictionary.containsNoSuggestWords

---

dictionaries

readonly dictionaries: SpellingDictionary[]

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionaryCollection.d.ts:4

---

getPreferredSuggestions?

optional getPreferredSuggestions?: (word) => PreferredSuggestion[]

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:121

Parameters

word

string

Returns

PreferredSuggestion[]

Inherited from

SpellingDictionary.getPreferredSuggestions

---

isDictionaryCaseSensitive

readonly isDictionaryCaseSensitive: boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:132

Inherited from

SpellingDictionary.isDictionaryCaseSensitive

---

mapWord?

optional mapWord?: MapWordSingleFn

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:123

Inherited from

SpellingDictionary.mapWord

---

name

readonly name: string

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:88

The name of the dictionary

Inherited from

SpellingDictionary.name

---

options

readonly options: SpellingDictionaryOptions

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:92

Options

Inherited from

SpellingDictionary.options

---

remapWord?

optional remapWord?: MapWordMultipleFn

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:130

Generates all possible word combinations by applying repMap. This acts a bit like brace expansions in globs.

Param

word

the word to map

Returns

array of adjusted words.

Inherited from

SpellingDictionary.remapWord

---

size

readonly size: number

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:131

Inherited from

SpellingDictionary.size

---

source

readonly source: string

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:90

The source, filename or URI

Inherited from

SpellingDictionary.source

---

terms?

optional terms?: () => Iterable<string>

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:138

Get all the terms in the dictionary, they may be formatted according to the dictionary options.

Returns

Iterable<string>

the terms in the dictionary.

Inherited from

SpellingDictionary.terms

---

type

readonly type: "SpellingDictionaryCollection"

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionaryCollection.d.ts:3

Overrides

SpellingDictionary.type

Methods

find()

find(word, options?): FindResult | undefined

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:101

A more detailed search for a word, might take longer than has

Parameters

word

string

options?

Readonly<FindOptions>

Returns

FindResult | undefined

Inherited from

SpellingDictionary.find

---

genSuggestions()

genSuggestions(collector, suggestOptions): void

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:122

Parameters

collector

SuggestionCollector

suggestOptions

SuggestOptionsRO

Returns

void

Inherited from

SpellingDictionary.genSuggestions

---

getErrors()

getErrors(): Error[]

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionaryCollection.d.ts:5

Returns

Error[]

Overrides

SpellingDictionary.getErrors

---

has()

has(word, options?): boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:99

Parameters

word

string

options?

Readonly<SearchOptions>

Returns

boolean

Inherited from

SpellingDictionary.has

---

isForbidden()

isForbidden(word, ignoreCaseAndAccents?): boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:106

Checks if a word is forbidden.

Parameters

word

string

word to check.

ignoreCaseAndAccents?

boolean

Returns

boolean

Inherited from

SpellingDictionary.isForbidden

---

isNoSuggestWord()

isNoSuggestWord(word, options): boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:114

No Suggest words are considered correct but will not be listed when suggestions are generated. No Suggest words and "Ignored" words are equivalent. Ignored / no suggest words override forbidden words.

Parameters

word

string

word to check

options

HasOptionsRO

options

Returns

boolean

Inherited from

SpellingDictionary.isNoSuggestWord

---

suggest()

suggest(word, suggestOptions?): SuggestionResult[]

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SpellingDictionary.d.ts:120

Generate suggestions for a word

Parameters

word

string

word

suggestOptions?

Readonly<SuggestOptions>

options

Returns

SuggestionResult[]

Inherited from

SpellingDictionary.suggest