quran-meta

Quran Meta

Static Badge Static Badge

GitHub License GitHub Repo stars GitHub package.json version

NPM Version npms.io npms.io npms.io npms.io NPM Downloads

NPM Type Definitions GitHub top language Quality Gate Status Static Badge

GitHub repo size GitHub code size in bytes npm bundle size npm bundle size

Welcome to Quran Meta Project - the most comprehensive Quran metadata library!

This project is to help with Quran related meta queries.

Answering Questions like:

Features

Upcoming Features

Future Roadmap

APi Reference Documentation

See here for API documentation

Playground

See in action and try it without installing anything:

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

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:

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:

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)
}

Here’s a paragraph describing this major feature:

Custom Riwaya Support - Build Your Own!

quran-meta now supports custom riwaya instances, allowing you to use the library with your own Quranic data sources. Whether you’re working with a different recitation style (riwaya) not yet included in the library, using an alternative pagination system (like different mushaf layouts with 13, 15, or 16 lines per page), or integrating region-specific Quranic metadata, you can now create your own QuranRiwaya instance with your custom data. Simply prepare your data in the required format (Lists structure with SurahList, JuzList, PageList, etc.) and instantiate the library with QuranRiwaya.create(riwayaName, customMeta, customLists).

All 40+ methods will work seamlessly with your data—including navigation (nextAyah, prevAyah), metadata queries (getAyahMeta, getSurahInfo), and advanced features (juz/page/ruku lookups). This opens up possibilities for researchers, developers working with regional mushaf standards, digital Quran applications targeting specific communities, and anyone needing Quranic metadata for specialized use cases.

The library’s architecture is designed to be data-agnostic—just plug in your data and everything works! For guidance on data structure requirements, see the API documentation or examine the existing riwaya implementations (Hafs, Qalun, Warsh) as reference examples.

We are commited to expanding support for more riwayas and pagination systems in future releases. Meanwhile, we welcome contributions from the community to help build a richer ecosystem of Quranic metadata.

Terminology

Examples

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

Projects using Quran-meta

Demo

Demo image

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

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:

License

This software is distributed under MIT license.

This site is open source. Improve this page.