Function: checkTextDocument()

checkTextDocument(doc, options, settings): Promise<CheckTextInfo>

Defined in: packages/cspell-lib/src/lib/textValidation/checkText.ts:81

Calculate document issues and include / exclude zones.

Parameters

doc

document to check

Document | TextDocument

options

CheckTextOptions

check options

settings

CSpellSettings = {}

optional settings

Returns

Promise<CheckTextInfo>