quran-meta
Version:
Library with meta data and functionality related to Holy Quran
16 lines (14 loc) • 560 B
text/typescript
import { RiwayaData } from "./lists/types.mjs";
import { Juz, JuzMeta } from "./types.mjs";
//#region src/getJuzMeta.d.ts
/**
* Retrieves metadata for a specific Juz of the Quran.
*
* @param juzNum - The Juz number to retrieve metadata for (1-30)
* @param data - The Lists object for the riwaya.
* @returns An object containing the Juz number, first ayah, and last ayah in the Juz
* @throws RangeError If the Juz number is not between 1 and 30
*/
declare function getJuzMeta(juzNum: Juz, data: RiwayaData): JuzMeta;
//#endregion
export { getJuzMeta };