Function: checkText()

checkText(text, settings): Promise<CheckTextInfo>

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

Annotate text with issues and include / exclude zones.

Parameters

text

string

the text to annotate.

settings

CSpellSettings

the settings to use.

Returns

Promise<CheckTextInfo>

the Check Text result

Deprecated