import { CSpellUserSettings } from '@cspell/cspell-types'; import { TextDocument } from '../Models/TextDocument'; import { Document } from '../spellCheckFile'; import { DocumentValidator, DocumentValidatorOptions } from './docValidator'; /** * Annotate text with issues and include / exclude zones. * @param text - the text to annotate. * @param settings - the settings to use. * @returns the Check Text result * @deprecated */ export declare function checkText(text: string, settings: CSpellUserSettings): Promise; /** * Annotate text with issues and include / exclude zones. * @param text - the text to annotate. * @param settings - the settings to use. * @returns the Check Text result * @deprecated */ export declare function checkTextOld(text: string, settings: CSpellUserSettings): Promise; export interface CheckTextInfo { text: string; items: TextInfoItem[]; } export interface TextInfoItem { text: string; startPos: number; endPos: number; flagIE: IncludeExcludeFlag; isError?: boolean; } export declare enum IncludeExcludeFlag { INCLUDE = "I", EXCLUDE = "E" } export interface CheckTextOptions extends DocumentValidatorOptions { } /** * Calculate document issues and include / exclude zones. * @param doc - document to check * @param options - check options * @param settings - optional settings * @returns */ export declare function checkTextDocument(doc: TextDocument | Document, options: CheckTextOptions, settings?: CSpellUserSettings): Promise; export declare function genCheckText(docValidator: DocumentValidator): Promise; //# sourceMappingURL=checkText.d.ts.map