quran-meta
Version:
Library with meta data and functionality related to Holy Quran
32 lines (30 loc) • 1.2 kB
JavaScript
import { checkValidRuku } from "./validation.mjs";
import { findSurahAyahByAyahId } from "./findSurahAyahByAyahId.mjs";
//#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
* @param data - The Lists object for the riwaya.
* @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, data) {
checkValidRuku(rukuNum, data.meta);
const RukuList = data.RukuList;
const [firstAyahId, nextRukuAyahId] = [RukuList[rukuNum], RukuList[rukuNum + 1]];
const lastAyahId = nextRukuAyahId - 1;
return {
rukuNum,
firstAyahId,
lastAyahId,
first: findSurahAyahByAyahId(firstAyahId, data),
last: findSurahAyahByAyahId(lastAyahId, data)
};
}
//#endregion
export { getRukuMeta };