Skip to main content

Function: spellCheckDocument()

spellCheckDocument(document, options, settingsOrConfigFile): Promise<SpellCheckFileResult>

Defined in: packages/cspell-lib/src/lib/spellCheckFile.ts:80

Spell Check a Document.

Parameters​

document​

document to be checked. If document.text is undefined the file will be loaded

Document | DocumentWithText

options​

SpellCheckFileOptions

options to control checking

settingsOrConfigFile​

CSpellSettings | ICSpellConfigFile

Returns​

Promise<SpellCheckFileResult>