quran-meta
Version:
Library with meta data and functionality related to Holy Quran
21 lines (19 loc) • 683 B
text/typescript
import { AyahNo, Juz, Surah } from "./types.cjs";
//#region src/isSurahAyahJuzFirst.d.ts
/**
* Determines if a given Surah and Ayah combination marks the beginning of a Juz.
*
* @param surah - The Surah number to check
* @param ayah - The Ayah number within the Surah to check
* @returns The Juz number if the combination marks the start of a Juz, -1 otherwise
* @throws Error When the provided Surah number is invalid
*
* @example
* ```typescript
* isSurahAyahJuzFirst(2, 142) // Returns 2
* isSurahAyahJuzFirst(2, 143) // Returns -1
* ```
*/
declare function isSurahAyahJuzFirst(surah: Surah, ayah: AyahNo): Juz | number;
//#endregion
export { isSurahAyahJuzFirst };