UNPKG

quran-meta

Version:

Library with meta data and functionality related to Holy Quran

github.com/quran-center/quran-meta

quran-center/quran-meta

10 lines (9 loc) • 438 B
1
2
3
4
5
6
7
8
9
10
import { AyahMeta, Page } from "./types"; /** * Retrieves metadata for a specific ayah of the Quran. * * @param ayahId - The ayahId number to retrieve metadata for (1-6236) * @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 */ export declare function getAyahMeta(ayahId: Page): AyahMeta;