quran-meta/src/findJuzMetaBySurah.ts

Library with meta data and functionality related to Holy Quran

import { meta } from "./const"
import { findJuzAndShift } from "./findJuzAndShift"
import { findSurahByAyahId } from "./findSurahByAyahId"
import { JuzList } from "./lists/juzList"
import { AyahNo, Juz, SurahJuzMeta as SurahJuzMeta, Surah } from "./types"

/**
 * Finds the SurahJuzMeta for a given Surah and Ayah.
 *
 * @param surah - The Surah (chapter) number.
 * @param ayah - The Ayah (verse) number.
 * @returns The SurahJuzMeta object containing the left juz, ayahs between juz and surah, right juz, ayah ID of first ayah in left juz, and last ayah ID of right juz .
 */
export function findJuzMetaBySurah(surah: Surah, ayah: AyahNo = 1): SurahJuzMeta {
  const {
    juz: leftjuz,
    ayahsBetweenJuzSurah,
    leftAyahId
  } = findJuzAndShift(surah, ayah)

  let rightJuz: Juz = leftjuz
  while (
    rightJuz < meta.numJuzs
    && findSurahByAyahId(JuzList[rightJuz + 1]) === surah
  ) {
    rightJuz++
  }

  return {
    leftjuz,
    ayahsBetweenJuzSurah,
    rightJuz,
    leftAyahId,
    rightAyahId: JuzList[rightJuz + 1] // todo check if this is correct or should be -1
  }
}