quran-meta
Version:
Library with meta data and functionality related to Holy Quran
22 lines (20 loc) • 732 B
text/typescript
import { RiwayaData } from "./lists/types.mjs";
import { AyahId, Ruku } from "./types.mjs";
//#region src/findRukuByAyahId.d.ts
/**
* Finds the Ruku number for a given Ayah ID using binary search.
*
* @param ayahId - The unique identifier of an Ayah in format: surah:ayah (e.g., "2:255")
* @param data - The Lists object for the riwaya.
* @returns The Ruku number corresponding to the given Ayah ID
* @throws {@link Error} If the provided Ayah ID is invalid
*
* @example
* ```ts
* const ruku = findRukuByAyahId("2:255", HafsLists);
* // Returns the Ruku number containing Ayah 255 of Surah 2
* ```
*/
declare function findRukuByAyahId(ayahId: AyahId, data: RiwayaData): Ruku;
//#endregion
export { findRukuByAyahId };