quran-meta/lib_es/isSurahAyahJuzFirst.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/isSurahAyahJuzFirst.ts
/**
* Determines if a given Surah and Ayah combination marks the beginning of a Juz.
*
* @param surah - The Surah number to check
* @param ayah - The Ayah number within the Surah to check
* @param data - The Lists object for the riwaya.
* @returns The Juz number if the combination marks the start of a Juz, -1 otherwise
* @throws Error When the provided Surah number is invalid
*
* @example
* ```typescript
* isSurahAyahJuzFirst(2, 142, HafsLists) // Returns 2
* isSurahAyahJuzFirst(2, 143, HafsLists) // Returns -1
* ```
*/
function isSurahAyahJuzFirst(surah, ayah, data) {
	const { JuzList, meta } = data;
	checkValidSurah(surah, meta);
	return binarySearch(JuzList, findAyahIdBySurah(surah, ayah, data));
}

//#endregion
export { isSurahAyahJuzFirst };