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