quran-meta
Version:
Library with meta data and functionality related to Holy Quran
20 lines (18 loc) • 605 B
text/typescript
import { AyahId, Ruku } from "./types.cjs";
//#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")
* @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");
* // Returns the Ruku number containing Ayah 255 of Surah 2
* ```
*/
declare function findRukuByAyahId(ayahId: AyahId): Ruku;
//#endregion
export { findRukuByAyahId };