Skip to main content

Interface: SuggestionCollector

Defined in: packages/cspell-trie-lib/dist/index.d.ts:349

Properties​

add()​

add: (suggestion) => SuggestionCollector

Defined in: packages/cspell-trie-lib/dist/index.d.ts:361

Parameters​

suggestion​

SuggestionResultBase

Returns​

SuggestionCollector

changeLimit​

readonly changeLimit: number

Defined in: packages/cspell-trie-lib/dist/index.d.ts:363

collect()​

collect: (src, timeout?, filter?) => void

Defined in: packages/cspell-trie-lib/dist/index.d.ts:360

Collection suggestions from a SuggestionIterator

Parameters​

src​

SuggestionGenerator

the SuggestionIterator used to generate suggestions.

timeout?​

number

the amount of time in milliseconds to allow for suggestions. before sending symbolStopProcessing Iterator implementation:

filter?​

FilterWordFn

Returns​

void

Example​

r = yield(suggestion);
if (r === collector.symbolStopProcessing) // ...stop generating suggestions.

genSuggestionOptions​

readonly genSuggestionOptions: GenSuggestionOptionsRO

Defined in: packages/cspell-trie-lib/dist/index.d.ts:369

ignoreCase​

readonly ignoreCase: boolean

Defined in: packages/cspell-trie-lib/dist/index.d.ts:368

includesTies​

readonly includesTies: boolean

Defined in: packages/cspell-trie-lib/dist/index.d.ts:367

maxCost​

readonly maxCost: number

Defined in: packages/cspell-trie-lib/dist/index.d.ts:364

maxNumSuggestions​

readonly maxNumSuggestions: number

Defined in: packages/cspell-trie-lib/dist/index.d.ts:366

suggestions​

readonly suggestions: SuggestionResult[]

Defined in: packages/cspell-trie-lib/dist/index.d.ts:362

symbolStopProcessing​

readonly symbolStopProcessing: symbol

Defined in: packages/cspell-trie-lib/dist/index.d.ts:373

Possible value sent to the SuggestionIterator telling it to stop processing.

word​

readonly word: string

Defined in: packages/cspell-trie-lib/dist/index.d.ts:365