Packages

spellweaver

0.1.4
0.1.8 0.1.7 retired 0.1.5 0.1.4 0.1.3 0.1.0

A spellchecker for Elixir, made with Bun and cspell

HexDocs

Current section

Files

Jump to
Readme
6 Versions
2 Dependencies
Dependants
Files
Activity
spellweaver priv bun node_modules cspell-lib dist lib trace.d.ts
Raw

priv/bun/node_modules/cspell-lib/dist/lib/trace.d.ts 

import type { CSpellSettings, LocaleId } from '@cspell/cspell-types';

import { ICSpellConfigFile } from 'cspell-config-lib';

import type { LanguageId } from './fileTypes.js';

import type { DictionaryTraceResult, WordSplits } from './textValidation/traceWord.js';

export interface TraceResult extends DictionaryTraceResult {

    /** True if the dictionary is currently active. */

    dictActive: boolean;

}

export interface TraceOptions {

    languageId?: LanguageId | LanguageId[];

    locale?: LocaleId;

    ignoreCase?: boolean;

    allowCompoundWords?: boolean;

}

export interface TraceWordResult extends Array<TraceResult> {

    splits: readonly WordSplits[];

}

export declare function traceWords(words: string[], settings: CSpellSettings | ICSpellConfigFile, options: TraceOptions | undefined): Promise<TraceResult[]>;

export declare function traceWordsAsync(words: Iterable<string> | AsyncIterable<string>, settingsOrConfig: CSpellSettings | ICSpellConfigFile, options: TraceOptions | undefined): AsyncIterableIterator<TraceWordResult>;

//# sourceMappingURL=trace.d.ts.map