quran-meta/lib_es/isSurahAyahPageFirst.mjs

Library with meta data and functionality related to Holy Quran

import { checkValidSurah } from "./validation.mjs";
import { findAyahIdBySurah } from "./findAyahIdBySurah.mjs";
import { binarySearch } from "./utils.mjs";

//#region src/isSurahAyahPageFirst.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
*/
function isSurahAyahPageFirst(surah, ayah, data) {
	const { PageList, meta } = data;
	checkValidSurah(surah, meta);
	return binarySearch(PageList, findAyahIdBySurah(surah, ayah, data));
}

//#endregion
export { isSurahAyahPageFirst };