quran-meta/lib_es/getRubAlHizbMeta.js

Library with meta data and functionality related to Holy Quran

import { findSurahAyahByAyahId } from "./findSurahAyahByAyahId.js";
import { HizbQuarterList } from "./lists/hizbQuarterList.js";
import { getRubAlHizb } from "./getRubAlHizb.js";

//#region src/getRubAlHizbMeta.ts
/**
* Retrieves the metadata for a specific quarter (rub' al-hizb) of the Quran.
*
* @param quarterIndex - The index of the quarter (rub' al-hizb) to retrieve metadata for, where 1 is the first quarter.
* @returns An object containing the metadata for the specified quarter, including the juz' (part), hizb (section), and the quarter (rub' al-hizb) index.
*/
function getRubAlHizbMeta(quarterIndex) {
	const res = getRubAlHizb(quarterIndex);
	const [firstAyahId, nextJuzAyahId] = [HizbQuarterList[quarterIndex], HizbQuarterList[quarterIndex + 1]];
	const lastAyahId = nextJuzAyahId - 1;
	return {
		firstAyahId,
		lastAyahId,
		first: findSurahAyahByAyahId(firstAyahId),
		last: findSurahAyahByAyahId(lastAyahId),
		...res
	};
}

//#endregion
export { getRubAlHizbMeta };