UNPKG

quran-meta

Version:

Library with meta data and functionality related to Holy Quran

github.com/quran-center/quran-meta

quran-center/quran-meta

15 lines (14 loc) • 603 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import { ManzilMeta } from "./types"; /** * Retrieves metadata for a specific Manzil (section) of the Quran * * @param manzilNum - The number of the Manzil (1-7) * @returns The metadata for the specified Manzil containing: * - manzilNum: The Manzil number * - firstAyahId: ID of the first ayah in the Manzil * - lastAyahId: ID of the last ayah in the Manzil * - first: Surah and ayah details of the first ayah * - last: Surah and ayah details of the last ayah * @throws Will throw an error if manzilNum is invalid */ export declare function getManzilMeta(manzilNum: number): ManzilMeta;