quran-meta
Version:
Library with meta data and functionality related to Holy Quran
21 lines (19 loc) • 789 B
text/typescript
import { RiwayaData } from "./lists/types.mjs";
import { ManzilMeta } from "./types.mjs";
//#region src/getManzilMeta.d.ts
/**
* Retrieves metadata for a specific Manzil (section) of the Quran
*
* @param manzilNum - The number of the Manzil (1-7)
* @param data - The Lists object for the riwaya.
* @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
*/
declare function getManzilMeta(manzilNum: number, data: RiwayaData): ManzilMeta;
//#endregion
export { getManzilMeta };