@sahabaplus/mushaf-engine/dist/kingFahadMushaf/index.d.ts

TypeScript implementation of a Quran Mushaf navigation engine

import { Mushaf } from "../mushaf";
/**
 * Interface for Verse data in the King Fahad Mushaf JSON format
 */
export interface JsonVerse {
    sura: number;
    ayah: number;
    lines: number;
    y: number;
    x: number;
}
/**
 * Loader for the King Fahad Mushaf edition
 */
export declare class KingFahadMushaf {
    /**
     * Load a Mushaf from the provided data object
     *
     * @param data - King Fahad Mushaf data as a JavaScript object (array of pages)
     * @returns A new Mushaf instance
     */
    static load(data: JsonVerse[][]): Mushaf;
    /**
     * Create a Mushaf from parsed JSON page data
     *
     * @param jsonPages - Array of pages, each containing an array of verse data
     * @returns A new Mushaf instance
     */
    private static createMushafFromPages;
}