lix-website/themes/lix/assets/bootstrap/node_modules/cspell-lib/dist/trace.d.ts
2024-04-26 22:49:34 -06:00

23 lines
921 B
TypeScript

import type { CSpellSettings, LocaleId } from '@cspell/cspell-types';
import { LanguageId } from './LanguageIds';
export interface TraceResult {
word: string;
found: boolean;
foundWord: string | undefined;
forbidden: boolean;
noSuggest: boolean;
dictName: string;
dictSource: string;
dictActive: boolean;
configSource: string;
errors: Error[] | undefined;
}
export interface TraceOptions {
languageId?: LanguageId | LanguageId[];
locale?: LocaleId;
ignoreCase?: boolean;
allowCompoundWords?: boolean;
}
export declare function traceWords(words: string[], settings: CSpellSettings, options: TraceOptions | undefined): Promise<TraceResult[]>;
export declare function traceWordsAsync(words: Iterable<string> | AsyncIterable<string>, settings: CSpellSettings, options: TraceOptions | undefined): AsyncIterableIterator<TraceResult[]>;
//# sourceMappingURL=trace.d.ts.map