quran-meta/src/getRubAlHizb.ts

Library with meta data and functionality related to Holy Quran

import type { HizbId, Juz, RubAlHizb, JuzPart, RubAlHizbId } from "./types"

/**
 * Retrieves the basic 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.
 *  @param riwaya - The riwaya. Defaults to "Hafs" if not provided.
 * @returns An object containing the metadata for the specified quarter, including the juz' (part), hizb (section), and the quarter (rub' al-hizb) index.
 */
export function getRubAlHizb(
  quarterIndex: RubAlHizbId
): RubAlHizb {
  // return HizbQuarterList[maqra]

  // const quarterIndex = HizbQuarterList.findIndex(x => x > ayahId) - 1

  // const juz = findJuzByAyahId(ayahId)
  const juz = (Math.floor((quarterIndex - 1) / 8) + 1) as Juz
  // isValidJuz(juz)

  const hizbIndex = (Math.floor((quarterIndex - 1) / 4) + 1) as HizbId
  const juzPart = (quarterIndex % 8 || 8) as JuzPart
  return { juz, hizbId: hizbIndex, juzPart, rubAlHizbId: quarterIndex }
}