quran-meta/src/findRubAlHizbByAyahId.ts

Library with meta data and functionality related to Holy Quran

import { HizbQuarterList } from "./lists/hizbList"
import { AyahId, Juz } from "./types"
import { checkValidAyahId } from "./validation"

/**
 * Finds the Maqra/Rub-al-Hizb  of the Quran that contains the given Ayah (verse) ID.
 *
 * @param ayahId - The ID of the Ayah (verse) to find the Juz for.
 * @returns The Maqra of the Quran that contains the given Ayah ID.
 */
export function findRubAlHizbByAyahId(ayahId: AyahId): Juz {
  checkValidAyahId(ayahId)

  return HizbQuarterList.findIndex(x => x > ayahId) - 1
}