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 sura (getAyaCountinSura)
• Is given aya
  • a sajdah ayah?
  • beginnning of a juz (isAyahJuzFirst)?
  • beginnning of a page?
• findJuz and findJuzByAyaid
• findPage by surah/aya
• Find next or previous ayah (nextAyah/prevAyah)
• converts [surah,aya] to ayaId and vice-verse ( findSurahByAyaid and findAyaidBySurah)

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

In Node.js:

var quranMeta = require('quran-meta');

APi Reference Documentation

See here for API documentation

Examples

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

Demo

• Quran Meta Visualiser - demo app showcasing number of methods from Quran-meta to build interactive visualisations of Quran structure using Alpine.js & chart.js

• Quran Meta Visualiser ES module version - ES Module version of the previous demo

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
UMD/ UMD minified builds can be used directly in the browser via a <script> (see here about UMD format)	ES5+UMD
CommonJS for use with older bundlers like browserify or webpack	ES5+CommonJS
ESM for use with modern bundlers like webpack 2 or Rollup	ES5+ESM
ESM Browser/ESM Browser minified for direct imports in modern browsers via <script type="module">	ESNext+ESM