Skip to main content

Function: spellCheckDocumentRPC()

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

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

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>