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

TypeScript implementation of a Quran Mushaf navigation engine

import { Verse } from "../mushaf/verse";
/**
 * Result of a navigation operation that exceeds the boundaries of a page or sura
 *
 * When navigation goes beyond available lines, this structure captures information
 * about the overflow including how many lines exceeded the boundary and which verse
 * was reached at the boundary.
 */
export declare class OverflowResult {
    /**
     * Number of lines that overflowed beyond the boundary
     */
    overflowLines: number;
    /**
     * The verse at the boundary where overflow occurred
     */
    overflowedVerse: Verse;
    /**
     * Create a new OverflowResult with specified parameters
     *
     * @param overflowLines - Number of lines that overflowed beyond the boundary
     * @param overflowedVerse - The verse at the boundary where overflow occurred
     */
    constructor(overflowLines: number, overflowedVerse: Verse);
    /**
     * Create a string representation of the overflow result
     */
    toString(): string;
}