quran-meta
Version:
Library with meta data and functionality related to Holy Quran
15 lines (13 loc) • 694 B
text/typescript
import { RiwayaData } from "./lists/types.mjs";
import { RubAlHizbId, RubAlHizbMeta } from "./types.mjs";
//#region src/getRubAlHizbMeta.d.ts
/**
* Retrieves the metadata for a specific quarter (rub' al-hizb) of the Quran.
*
* @param quarterIndex - The index of the quarter (rub' al-hizb) to retrieve metadata for, where 1 is the first quarter.
* @param data - The Lists object for the riwaya.
* @returns An object containing the metadata for the specified quarter, including the juz' (part), hizb (section), and the quarter (rub' al-hizb) index.
*/
declare function getRubAlHizbMeta(quarterIndex: RubAlHizbId, data: RiwayaData): RubAlHizbMeta;
//#endregion
export { getRubAlHizbMeta };