quran-meta/lib_cjs/isSurahAyahPageFirst.cjs

Library with meta data and functionality related to Holy Quran

const require_validation = require('./validation.cjs');
const require_findAyahIdBySurah = require('./findAyahIdBySurah.cjs');
const require_utils = require('./utils.cjs');

//#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) {
	require_validation.checkValidSurah(surah, data.meta);
	const ayahId = require_findAyahIdBySurah.findAyahIdBySurah(surah, ayah, data);
	const PageList = data.PageList;
	return require_utils.binarySearch(PageList, ayahId);
}

//#endregion
exports.isSurahAyahPageFirst = isSurahAyahPageFirst;