quran-meta/lib_es/findManzilByAyahId.js

Library with meta data and functionality related to Holy Quran

import { checkValidAyahId } from "./validation.js";
import { binarySearch } from "./utils.js";
import { ManzilList } from "./lists/manzilList.js";

//#region src/findManzilByAyahId.ts
/**
* Finds the Manzil number for a given Ayah ID using binary search.
* A Manzil is one of seven approximately equal divisions of the Quran.
*
* @param ayahId - The ID of the Ayah to find the Manzil for
* @returns The Manzil number (1-7) containing the specified Ayah
* @throws {@link Error} If the provided Ayah ID is invalid
*
* @example
* ```typescript
* const manzil = findManzilByAyahId(2345); // Returns the Manzil containing Ayah 2345
* ```
*/
function findManzilByAyahId(ayahId) {
	checkValidAyahId(ayahId);
	const jj = binarySearch(ManzilList, ayahId);
	const juz = jj < 0 ? -jj - 2 : jj;
	return juz;
}

//#endregion
export { findManzilByAyahId };