UNPKG

quran-meta

Version:

Library with meta data and functionality related to Holy Quran

github.com/quran-center/quran-meta

quran-center/quran-meta

14 lines (13 loc) • 684 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { RukuMeta } from "./types"; /** * Retrieves metadata for a specific Ruku (section) of the Quran. * @param rukuNum - The number of the Ruku to retrieve metadata for * @returns {@link RukuMeta} An object containing metadata about the Ruku including: * - rukuNum: The Ruku number * - firstAyahId: The global Ayah ID of the first verse in this Ruku * - lastAyahId: The global Ayah ID of the last verse in this Ruku * - first: The Surah and Ayah numbers for the first verse * - last: The Surah and Ayah numbers for the last verse * @throws Will throw an error if the provided Ruku number is invalid */ export declare function getRukuMeta(rukuNum: number): RukuMeta;