Skip to main content

Function: spellCheckFile()

spellCheckFile(file, options, settingsOrConfigFile): Promise<SpellCheckFileResult>

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

Spell Check a file

Parameters

file

absolute path to file to read and check.

string | URL | Uri

options

SpellCheckFileOptions

options to control checking

settingsOrConfigFile

CSpellSettings | ICSpellConfigFile

Returns

Promise<SpellCheckFileResult>