@sahabaplus/mushaf-engine/dist/mushaf/page.d.ts

TypeScript implementation of a Quran Mushaf navigation engine

import { Verse } from './verse';
/**
 * Representation of a single page in the Quran
 *
 * Contains the page number and all verses that appear on this page,
 * with their positions and metadata.
 */
export declare class Page {
    /**
     * Page number (1-indexed)
     */
    private _number;
    /**
     * Collection of verses appearing on this page
     */
    private _verses;
    /**
     * Create a new Page with the specified parameters
     *
     * @param number - Page number (1-indexed)
     * @param verses - Array containing all verses on this page
     */
    constructor(number?: number, verses?: Verse[]);
    /**
     * Get the page number
     *
     * @returns The page number (1-indexed)
     */
    get number(): number;
    /**
     * Get all verses on this page
     *
     * @returns An array containing all verses on this page
     */
    verses(): Verse[];
    /**
     * Get the total number of verses on this page
     *
     * @returns The number of verses on this page
     */
    totalVerses(): number;
    /**
     * Create a string representation of the page
     */
    toString(): string;
}