quran-meta/src/findThumunAlHizb.ts

Library with meta data and functionality related to Holy Quran

import type { RiwayahsWith } from "./lists/types"
import { findAyahIdBySurah } from "./findAyahIdBySurah"
import { findThumunAlHizbByAyahId } from "./findThumunAlHizbByAyahId"
import type { AyahId, AyahNo, Surah, ThumunAlHizbId } from "./types"
import { checkValidSurah } from "./validation"

/**
 * Finds the Juz (part) and thumun-ul-Hizb (Eighth section) of the Quran that the given Ayah (verse) belongs to.
 *
 * @param surah - The Surah (chapter) number.
 * @param ayah - The Ayah (verse) number. Defaults to 1 if not provided.
 *  @param riwaya - The riwaya. Defaults to "Qalun" if not provided.
 * @returns An object containing the Juz (part) number, Hizb (section) number, and the index of the Hizb that the given Ayah belongs to.
 */
export function findThumunAlHizb(surah: Surah, ayah: AyahNo = 1, data: RiwayahsWith<"HizbEighthList">): ThumunAlHizbId {
  checkValidSurah(surah, data.meta)
  const ayahId: AyahId = findAyahIdBySurah(surah, ayah, data)

  return findThumunAlHizbByAyahId(ayahId, data)
}