quran-meta/lib_cjs/findRangeAroundAyah.d.cts

Library with meta data and functionality related to Holy Quran

import { AyahId, AyahRange, RangeMode } from "./types.cjs";

//#region src/findRangeAroundAyah.d.ts

/**
 * Finds the range of ayahs surrounding a given ayah based on specified mode
 * @param ayahId - The unique identifier of the ayah
 * @param mode - The scope for finding the range:
 *   - "juz": Returns range of ayahs in the same juz
 *   - "surah": Returns range of ayahs in the same surah
 *   - "ayah": Returns the single ayah as both start and end of range
 *   - "page": Returns range of ayahs on the same page
 *   - "ruku": Returns range of ayahs on the same ruku
 *   - "all": Returns range covering all ayahs (1 to total number of ayahs)
 * @returns An array of two numbers representing the start and end ayah IDs of the range [startAyahId, endAyahId]
 */
declare function findRangeAroundAyah(ayahId: AyahId, mode: RangeMode): AyahRange;
//#endregion
export { findRangeAroundAyah };