quran-meta/lib_cjs/isAyahJuzFirst.d.cts

Library with meta data and functionality related to Holy Quran

import { RiwayaData } from "./lists/types.cjs";
import { AyahId, Juz } from "./types.cjs";

//#region src/isAyahJuzFirst.d.ts

/**
 * Returns the Juz (part) number that the given Ayah (verse) belongs to.
 *
 *
 * @param ayahId - The Ayah Id (verse) number.
 * @param data - The Lists object for the riwaya.
 * @returns The Juz (part) number that the given Ayah belongs to. Returns Positive number if ayah is first ayah of juz, number is juz number
 */
declare function isAyahJuzFirst(ayahId: AyahId, data: RiwayaData): Juz | number;
//#endregion
export { isAyahJuzFirst };