@sahabaplus/mushaf-engine/dist/navigation/lastVerseResult.d.ts

TypeScript implementation of a Quran Mushaf navigation engine

import { Verse } from '../mushaf/verse';
/**
 * Information about the last verse of a page or sura encountered during navigation
 *
 * This class tracks the last verse of either a page or a sura along with
 * the distance of lines that were still available for navigation after reaching this verse.
 * Negative distance of lines indicate an overflow beyond this verse.
 */
export declare class LastVerseResult {
    /**
     * Distance of lines available for navigation (negative indicates overflow)
     */
    linesDistance: number;
    /**
     * The last verse of the page or sura
     */
    lastVerse: Verse;
    /**
     * Create a new LastVerseResult with specified parameters
     *
     * @param linesDistance - Distance of lines available for navigation (negative indicates overflow)
     * @param lastVerse - The last verse of the page or sura
     */
    constructor(linesDistance: number, lastVerse: Verse);
    /**
     * Create a string representation of the last verse result
     */
    toString(): string;
}