quran-meta/lib_es/getRukuMeta.js

Library with meta data and functionality related to Holy Quran

import { checkValidRuku } from "./validation.js";
import { findSurahAyahByAyahId } from "./findSurahAyahByAyahId.js";
import { RukuList } from "./lists/rukuList.js";

//#region src/getRukuMeta.ts
/**

* Retrieves metadata for a specific Ruku (section) of the Quran.

* @param rukuNum - The number of the Ruku to retrieve metadata for

* @returns {@link RukuMeta} An object containing metadata about the Ruku including:

*  - rukuNum: The Ruku number

*  - firstAyahId: The global Ayah ID of the first verse in this Ruku

*  - lastAyahId: The global Ayah ID of the last verse in this Ruku

*  - first: The Surah and Ayah numbers for the first verse

*  - last: The Surah and Ayah numbers for the last verse

* @throws Will throw an error if the provided Ruku number is invalid

*/
function getRukuMeta(rukuNum) {
	checkValidRuku(rukuNum);
	const [firstAyahId, nextRukuAyahId] = [RukuList[rukuNum], RukuList[rukuNum + 1]];
	const lastAyahId = nextRukuAyahId - 1;
	return {
		rukuNum,
		firstAyahId,
		lastAyahId,
		first: findSurahAyahByAyahId(firstAyahId),
		last: findSurahAyahByAyahId(lastAyahId)
	};
}

//#endregion
export { getRukuMeta };