symspell-ex/lib/symSpellEx.d.ts

Spelling correction & Fuzzy search based on symmetric delete spelling correction algorithm

import { DataStore, EditDistance, Suggestion, Correction } from "./core";
import { DamerauLevenshteinDistance } from "./core/nlp/editDistance";
import { CoreTokenizer } from "./core/nlp/tokenizers";
export declare class SymSpellEx {
    store: DataStore;
    editDistance: EditDistance;
    private _tokenizer;
    private readonly _maxDistance;
    private readonly _maxSuggestions;
    private _language;
    private _isInitialized;
    constructor(store: DataStore, editDistance?: DamerauLevenshteinDistance, tokenizer?: CoreTokenizer, maxDistance?: number, maxSuggestions?: number);
    initialize(): Promise<void>;
    isInitialized(): boolean;
    get maxDistance(): Number;
    get maxSuggestions(): Number;
    setLanguage(language: string): Promise<void>;
    get language(): string;
    private _checkForReadiness;
    private edits;
    private filterAndRankSuggestions;
    lookup(term: string, language?: string, maxDistance?: number, maxSuggestions?: number): Promise<Array<Suggestion>>;
    add(term: string, frequency?: number, language?: string, maxDistance?: number): Promise<void>;
    /**
     * Train on bulk data
     * @param {Array<string>} terms - each item is comma separated value contains "term,frequency"
     * @param {string} language
     * @returns {Promise<void>}
     */
    train(terms: Array<string>, language: string): Promise<void>;
    search(input: string, language: string, maxDistance?: number, maxSuggestions?: number): Promise<Array<Suggestion>>;
    correct(input: string, language: string, maxDistance?: number): Promise<Correction>;
    clear(): Promise<void>;
}