quran-meta
Version:
Library with meta data and functionality related to Holy Quran
15 lines (13 loc) • 592 B
text/typescript
import { AyahNo, AyahRange, RangeMode, Surah } from "./types.cjs";
//#region src/findRangeAroundSurahAyah.d.ts
/**
* Finds a range of ayahs around a given ayah based on the specified mode.
*
* @param surah - The surah number (1-114)
* @param ayah - The ayah number within the surah
* @param mode - The range mode: "juz", "surah", "ayah", "page", "ruku" or "all"
* @returns A tuple containing the start and end ayah IDs of the range
*/
declare function findRangeAroundSurahAyah(surah: Surah, ayah: AyahNo, mode: RangeMode): AyahRange;
//#endregion
export { findRangeAroundSurahAyah };