quran-meta/lib_cjs/findRukuByAyahId.cjs

Library with meta data and functionality related to Holy Quran

const require_validation = require('./validation.cjs');
const require_utils = require('./utils.cjs');
const require_rukuList = require('./lists/rukuList.cjs');

//#region src/findRukuByAyahId.ts
/**
* Finds the Ruku number for a given Ayah ID using binary search.
*
* @param ayahId - The unique identifier of an Ayah in format: surah:ayah (e.g., "2:255")
* @returns The Ruku number corresponding to the given Ayah ID
* @throws {@link Error} If the provided Ayah ID is invalid
*
* @example
* ```ts
* const ruku = findRukuByAyahId("2:255");
* // Returns the Ruku number containing Ayah 255 of Surah 2
* ```
*/
function findRukuByAyahId(ayahId) {
	require_validation.checkValidAyahId(ayahId);
	const jj = require_utils.binarySearch(require_rukuList.RukuList, ayahId);
	const juz = jj < 0 ? -jj - 2 : jj;
	return juz;
}

//#endregion
exports.findRukuByAyahId = findRukuByAyahId;