@dcoffey/espells/lib/reader.d.ts

Pure JS/TS spellchecker, using Hunspell dictionaries. Based on Spylls.

/** Wrapper for manipulating a document separated by lines. */
export declare class Reader {
    lines: string[];
    index: number;
    line: string;
    /** @param input - Document to read. */
    constructor(input: string | Uint8Array);
    /** True if the reader has reached the end of the document. */
    get done(): boolean;
    /** Advances the reader one line. */
    next(): true | null;
    /**
     * Advances the reader a given number of steps, calling a callback
     * function for each line it steps through.
     *
     * @param steps - The number of lines to step through.
     * @param cb - The callback function to call. Return false to further advancing.
     */
    for(steps: number, cb: (line: string) => void | boolean): void;
}