Skip to main content

Function: spellCheckFile()

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

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

Spell Check a file

Parameters​

file​

string | URL | Uri

absolute path to file to read and check.

options​

SpellCheckFileOptions

options to control checking

settingsOrConfigFile​

CSpellSettings | ICSpellConfigFile

default settings to use.

Returns​

Promise<SpellCheckFileResult>