@sahabaplus/mushaf-engine/dist/mushafEngine/verseLocation.d.ts

TypeScript implementation of a Quran Mushaf navigation engine

import { Verse } from "../mushaf";
/**
 * A verse resolved in the mushaf together with its page placement.
 */
export interface VerseLocation {
    /** The verse instance from the mushaf layout */
    verse: Verse;
    /** 1-based page number in this mushaf */
    pageNumber: number;
    /** 0-based index of this verse in that page's `verses()` array */
    verseIndexOnPage: number;
}