Skip to main content

Function: spellcheckProjectedTextWithCspell()

spellcheckProjectedTextWithCspell(text: string, collection: Readonly<SpellingDictionaryCollection>, options: Readonly<SpellcheckProjectedTextOptions>): readonly Readonly<{ endOffset: number; reason: string; startOffset: number; }>[]

Defined in: _internal/spellcheck-cspell.ts:994

Spellcheck projected markdown text with the assembled cspell dictionaries.

Parameters​

text​

string

Projected markdown comment text.

collection​

Readonly<SpellingDictionaryCollection>

Prebuilt cspell dictionary collection.

options​

Readonly<SpellcheckProjectedTextOptions>

Runtime spellcheck behavior.

Returns​

readonly Readonly<{ endOffset: number; reason: string; startOffset: number; }>[]

Stable issue offsets and human-readable reasons.