quran-meta
Version:
Library with meta data and functionality related to Holy Quran
16 lines (14 loc) • 624 B
text/typescript
import { RiwayaData } from "./lists/types.cjs";
import { AyahId, AyahMeta } from "./types.cjs";
//#region src/getAyahMeta.d.ts
/**
* Retrieves metadata for a specific ayah of the Quran.
*
* @param ayahId - The ayahId number to retrieve metadata for (1-6236)
* @param data - The Lists object for the riwaya.
* @returns An object containing the ayah related meta, including information about the surah, juz, and quarter the ayah is in.
* @throws RangeError If the ayahId number is not between 1 and 6236
*/
declare function getAyahMeta(ayahId: AyahId, data: RiwayaData): AyahMeta;
//#endregion
export { getAyahMeta };