quran-meta/lib_cjs/isSurahAyahPageFirst.d.cts

Library with meta data and functionality related to Holy Quran

import { RiwayaData } from "./lists/types.cjs";
import { AyahNo, Page, Surah } from "./types.cjs";

//#region src/isSurahAyahPageFirst.d.ts

/**
 * Determines if an ayah is the first ayah on its page in the Quran
 * @param surah - The surah number (1-114)
 * @param ayah - The ayah number within the surah
 * @param lists - The Lists object for the riwaya.
 * @returns The page number if the ayah is first on its page, -1 otherwise
 * @throws Error If surah number is invalid
 */
declare function isSurahAyahPageFirst(surah: Surah, ayah: AyahNo, data: RiwayaData): Page | number;
//#endregion
export { isSurahAyahPageFirst };