Quran Meta

Welcome to Quran Meta Project

This project is to help with Quran related meta queries.

Answering Questions like:

• How many ayahs in given surah (getAyahCountinSurah)
• Is given ayah
  • a sajdah ayah (getAyahMeta)?
  • beginnning of a page (isAyahPageFirst)?
  • beginnning of a juz (isAyahJuzFirst)?
• Find
  • next or previous ayah (nextAyah/prevAyah)
  • juz findJuz and findJuzByAyahId
  • maqra/rub-el-hizb findRubAlHizb, getRubAlHizbMetaByAyahId
  • page findPage by surah/ayah
  • AyahId of a given surah/ayah (findAyahIdBySurah)
  • find range around ayah (findRangeAroundAyah)
• Get meta data for
  • ayah (getAyahMeta)
  • surah (getSurahInfo, getSurahInfo)
  • page (getPageMeta)
  • juz (findJuzMetaBySurah)
  • maqra/rub-el-hizb (getRubAlHizbMeta, getRubAlHizbMetaByAyahId)
• Validates ayah/surah id (checkValidAyahId,checkValidSurah, checkValidSurahAyah)
• Typescript type guards (isValidAyahId, isValidAyahNo, isValidSurah, isValidSurahAyah, isValidJuz, isValidHizb, isValidRubAlHizb, isValidPage)
• converts [surah, ayah] to ayahId and vice-verse ( findSurahByAyahId and findAyahIdBySurah)
• Checks and turns strings of type "x:y" or "x:y1-y2" to surah/ayah range (ayaStringSplitter).
• Checks and parses strings of type "x" to Surah (surahStringParser).

APi Reference Documentation

See here for API documentation

Playground

See in action and try it without installing anything:

• [ - interactive playground for Quran-Meta

Installation

In a browser:

<script src="quran-meta.js"></script>

Also modern browsers allow

<script type="module">
import quranMeta from "quran-meta.esm.js"
</script>

The library is available from various CDNs

• JSDelivr
• UnPKG

Using npm:

$ npm i --save quran-meta

Usage

Tree-Shakeable Riwaya-Specific Imports (Recommended)

For optimal bundle size, import from riwaya-specific entry points. This ensures only the data you need is bundled:

// Hafs-specific import (only Hafs data bundled, ~50% smaller)
import { getAyahMeta, findJuz, meta, quran } from "quran-meta/hafs"

console.log(`Total ayahs: ${meta.numAyahs}`) // 6236

// Using functional API (Hafs is default)
const ayahMeta = getAyahMeta(1)
console.log(ayahMeta.juz) // => 1

// Using class API
const next = quran.nextAyah(1, 7)
console.log(next) // => [2, 1]

// Qalun-specific import (only Qalun data bundled)
import { getAyahMeta, findThumunAlHizb, meta, quran } from "quran-meta/qalun"

console.log(`Total ayahs: ${meta.numAyahs}`) // 6214
console.log(`Thumun al-Hizbs: ${meta.numThumunAlHizbs}`) // 480

// Qalun-specific features available
const thumun = findThumunAlHizb(1, 1)
console.log(thumun) // => 1

const ayahMeta = getAyahMeta(1)
console.log(ayahMeta.thumunAlHizbId) // Available in Qalun!

Benefits of riwaya-specific imports:

• ✅ 50% smaller bundle - only loads the riwaya you need
• ✅ Zero configuration - works immediately, no initialization required
• ✅ Tree-shakeable - unused riwayas are eliminated by bundlers
• ✅ Type-safe - full TypeScript support with correct types per riwaya
• ✅ Future-proof - easily add new riwayas without breaking changes

Class-Based API

For generic code that works with multiple riwayas, use the class-based API:

import { QuranRiwaya } from "quran-meta"

// Create a Hafs instance
const hafs = QuranRiwaya.hafs()

// Get surah metadata
const surahMeta = hafs.getSurahMeta(2)
console.log(surahMeta.name) // => 'البَقَرَة'
console.log(surahMeta.ayahCount) // => 286

// Find juz information
const juz = hafs.findJuz(2, 1)
console.log(juz) // => 1

// Check if ayah is first in juz
const isFirst = hafs.isAyahJuzFirst(149)
console.log(isFirst) // => 2

// Get ayah metadata
const ayahMeta = hafs.getAyahMeta(1)
console.log(ayahMeta) // => { surah: 1, ayah: 1, juz: 1, page: 1, ... }

// Navigation
const next = hafs.nextAyah(1, 7)
console.log(next) // => [2, 1]

// Use Qalun riwaya for Thumun al-Hizb support
const qalun = QuranRiwaya.qalun()
const thumun = qalun.findThumunAlHizb(1, 1)
console.log(thumun) // => 1

// Create custom riwaya instance
const custom = QuranRiwaya.create("Hafs")

Benefits of the class-based API:

• ✓ No repetitive riwaya parameter in every function call
• ✓ Clear context with a dedicated instance
• ✓ Better IDE autocomplete and type safety
• ✓ Chainable and fluent API
• ✓ Riwaya-specific methods (e.g., Qalun's Thumun al-Hizb)

Legacy Functional API

The original functional API is still available for backward compatibility:

In Node.js see example here:

var quranMeta = require("quran-meta")

console.log(" Assalam Aleykum! ") // => 'Assalam Aleykum!'
console.log(`There are ${quranMeta.meta.numSurahs} suras in the Holy Quran`) // => 'There are 114 suras in the Holy Quran'

In the browser/ES:

import { meta } from "quran-meta"
console.log("Assalam Aleykum!")
console.log(`There are ${meta.numSurahs} suras in the Holy Quran`) // => 'There are 114 suras in the Holy Quran'

In TypeScript:

import { meta, getAyahCountinSurah, AyahNo, Surah } from "quran-meta"

console.log(`There are ${meta.numSurahs} suras in the Holy Quran`)

for (let surah: Surah = 1; surah <= meta.numSurahs; surah++) {
  const ayaCount = getAyahCountinSurah(surah)
  console.log(surah, ': ',ayaCount)
}

Terminology

• Surah: A chapter of the Quran. There are 114 chapters in Quran, each of different length.

• Ayah: A verse number in the particular surah (chapter) of Quran. it is relative to the surah.

• AyahId: Unique identifier for a verse in the Quran. It is a number that is the concatenation of the of sum ayahs of previous chapters of Quran and the verse number of particular Ayah. There are 6236 ayahs in Quran. AyahId is absolute, positive and is not relative to any surah.

• Juz: A section of the Quran. There are 30 Juz (ajza) in Quran of roughly equal length. Most Juz' are named after the first word of the first verse of the Juz'. Read more here

• Hizb: Each Juz' is divided into two Hizb (lit. "two groups", plural: Aḥzāb). Therefore, there are 60 Hizbs (ahzab) in the Quran.

• Rub-el-Hizb/Maqra: Each Hizb is subdivided into four quarters called Maqra (lit. "reading"), making eight quarters per Juz. In Arabic, rub means 'one-fourth' or 'quarter', while ḥizb (plural aḥzāb) translates to 'a group'. There are 240 Maqras in the Quran. In most mushafs it is noted by symbol in the shape of an octagram, represented as two overlapping squares ۞. Read more here

• Manzil: For the convenience of those who read the Quran in a week the text may be divided into seven portions. Each portion is called a Manzil. There are 7 Manzil in Quran. Read more here

• Page: A section of the Quran that contains 15 lines (Madina mushaf)(depends on the mushaf).

• Saajdah: Special ayahs that require reader to prostrate. There are 15 of them in Quran.

• Ruku: (paragraph) is a group of related verses in a Surah. The end of a Ruku’ is marked by the Arabic letter ﻉ in superscript. There are 558 Rukus in the Quran. These are logical sections according to similar theme/objective or meaning. The bigger Surahs have been split into a number of Rukus, so that we would recognize when to do Ruku' (bowing) in Salat without interrupting a proceeding subject of the Quran. Additionally, on the margins of the Quran, usually three figures are written with ﻉ. The top figure shows the number of Rukus completed in that Surah. The middle figure shows the number of Ayats in the Ruku just completed. The bottom figure shows the number of Rukus completed in that Juz.

Examples

You can find some examples here and souce code for them here

Projects using Quran-meta

• Koran-Center - Powerful and feature rich web application for reading and studying the Holy Quran.

Demo

• Quran Meta Visualiser ESM Alpine3 - demo app showcasing number of methods from Quran-meta to build interactive visualisations of Quran structure using Alpine.js 3 & Chart.js 4 in ESM format.

• Quran Meta Visualiser ES module version - Alpine.js 2& ChartJs.2 version of the previous demo

• Quran Meta Visualiser CJS - CommonJS version of the previous demo

Data correctness and validity testing

Quran-Meta is 100% unit test covered and moreover data is cross checked with other apis to guarantee absolute correctness.

One can run pnpx jiti examples/data-check to run suite of validation tests against the following data sources

• qcloud-meta.json - AlQuran Cloud Api metadata
• tanzil-data.js - Tanzil.net metadata
• quran-api.json - Quran Api metadata
• hafsData_v2-0.json - Data coming with KFGQPC Hafs Uthmanic font
• hafs_smart_v8.json - Data coming with KFGQPC Smart device UthmanicHafs font
• SousiData_v2-0.json - Data coming with KFGQPC Sousi Uthmanic font
• DouriData_v2-0.json - Data coming with KFGQPC Douri Uthmanic font
• QalounData_v2-1.json - Data coming with KFGQPC Qaloun Uthmanic font
• shubaData_v2-0.json - Data coming with KFGQPC Shuba Uthmanic font
• warshData_v2-1.json - Data coming with KFGQPC Warsh Uthmanic font

There are some differences with KFQC data in page numbering, due to variations between different mushafs. We plan to address these differences in future updates by supporting multiple page numbering systems of different mushafs (15 line, 16 line and etc).

Any suggestion to further improve this are welcome.

Distributions and Downloads

Here you can find the following

||| |--|--| |Source code in typescript | TS | | Javascript code autotranspiled from TS as ES Next | ESNext | |Javascript code autotranspiled from TS as CJS|ES5+CommonJS| ||| Distributions of library as| | | ESM for use with modern bundlers like webpack 2 or Rollup and for direct imports in modern browsers via <script type="module">| ES5+ESM | | IIFE for use with classic browsers via <script>| IIFE |

References:

• Tanzil.net
• Quran.com Js Api, Quran.com API,
• AlQuran Cloud
• KFQC Data

License

This software is distributed under MIT license.