quran-meta
Advanced tools
This project is to help with Quran related meta queries.
Answering Questions like:
getAyahCountinSurah)getAyahMeta)?isAyahPageFirst)?isAyahJuzFirst)?nextAyah/prevAyah)findJuz and findJuzByAyahIdfindRubAlHizb, getRubAlHizbMetaByAyahIdfindPage by surah/ayahfindAyahIdBySurah)findRangeAroundAyah)getAyahMeta)getSurahMeta)getPageMeta)findJuzMetaBySurah)getRubAlHizbMeta, getRubAlHizbMetaByAyahId)checkValidAyahId,checkValidSurah, checkValidSurahAyah)[surah, ayah] to ayahId and vice-verse ( findSurahByAyahId and findAyahIdBySurah)ayaStringSplitter.See in action and try it without installing anything:
<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
$ npm i --save quran-meta
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)
}
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 in Quran of roughly equal length.
Hizb: Each Juz' is divided into two Hizb. Therefore, there are 60 Hizbs in the Quran.
Rub-el-Hizb/Maqra: Each Hizb is subdivided into four quarters called Maqra, 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.
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.
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.
See here for API documentation
You can find some examples here and souce code for them here
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
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 metadatatanzil-data.js - Tanzil.net metadataquran-api.json - Quran Api metadatahafsData_v2-0.json - Data coming with UthmanicHafs font from KFQChafs_smart_v8.json - Data coming with Smart device UthmanicHafs font from KFQCAny suggestion to further improve this are welcome.
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 and for direct imports in modern browsers via <script type="module"> | ES5+ESM |
This software is distributed under MIT license.
FAQs
Library with meta data and functionality related to Holy Quran
The npm package quran-meta receives a total of 415 weekly downloads. As such, quran-meta popularity was classified as not popular.
We found that quran-meta demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.