quran-meta/lib_cjs/findJuzAndShift.d.cts

Library with meta data and functionality related to Holy Quran

import { AyahCountBetweenJuzSurah, AyahId, AyahNo, Juz, Surah } from "./types.cjs";

//#region src/findJuzAndShift.d.ts

/**
 * Finds the juz (section) that contains the specified ayah (verse) and calculates the number of ayahs between the start of the juz and the start of the surah (chapter) that contains the ayah.
 *
 * @param surah - The surah (chapter) that contains the ayah.
 * @param ayah - The ayah (verse) number.
 * @returns An object containing the following properties:
 *   - `juz`: The juz (section) that contains the ayah.
 *   - `leftAyahId`: The ayah ID of the first ayah in the juz.
 *   - `ayahsBetweenJuzSurah`: The number of ayahs between the start of the juz and the start of the surah (positive if the surah starts is in the juz, negative if the surah starts before the juz).
 */
declare function findJuzAndShift(surah: Surah, ayah: AyahNo): {
  juz: Juz;
  leftAyahId: AyahId;
  ayahsBetweenJuzSurah: AyahCountBetweenJuzSurah;
};
/**
 * Finds the Juz number and calculates the shift between Juz start and Surah start for a given Ayah ID
 *
 * @param ayahId - The unique identifier of an Ayah (verse) in the Quran
 *
 * @returns An object containing:
 * - juz: The Juz number where the Ayah is located
 * - leftAyahId: The starting Ayah ID of the Juz
 * - ayahsBetweenJuzSurah: The number of Ayahs between the Juz start and the Surah start
 *
 * @throws Error If the provided Ayah ID is invalid
 */
declare function findJuzAndShiftByAyahId(ayahId: AyahId): {
  juz: Juz;
  leftAyahId: AyahId;
  ayahsBetweenJuzSurah: AyahCountBetweenJuzSurah;
};
//#endregion
export { findJuzAndShift, findJuzAndShiftByAyahId };