quran-meta
Version:
Library with meta data and functionality related to Holy Quran
18 lines (16 loc) • 750 B
text/typescript
import { RukuMeta } from "./types.cjs";
//#region src/getRukuMeta.d.ts
/**
* Retrieves metadata for a specific Ruku (section) of the Quran.
* @param rukuNum - The number of the Ruku to retrieve metadata for
* @returns {@link RukuMeta} An object containing metadata about the Ruku including:
* - rukuNum: The Ruku number
* - firstAyahId: The global Ayah ID of the first verse in this Ruku
* - lastAyahId: The global Ayah ID of the last verse in this Ruku
* - first: The Surah and Ayah numbers for the first verse
* - last: The Surah and Ayah numbers for the last verse
* @throws Will throw an error if the provided Ruku number is invalid
*/
declare function getRukuMeta(rukuNum: number): RukuMeta;
//#endregion
export { getRukuMeta };