mushaf v0.0.8

Contents

• Installation
  • Mushaf
  • Qari/Rawi

• Usage - Surah & Chapter - Ayah & Verse - Juz - Maqra & Section - Raw - Useful methods

• Source & licensing

Installation

Mushaf

npm i mushaf

Qari / Rawi

Install a Qari set. Check the Qari/Rawi list.

npm i @saqfish/asim

Usage

import data from 'mushaf'
import { hafs } from '@saqfish/asim'

let mushaf;
mushaf = data(hafs);

Surah & Chapter

mushaf.surah() // Array of surahs/chapters
mushaf.surah(surah) // Surah n data
mushaf.chapter(surah) // Surah n data

// Example
mushaf.surah(113)

// return
{
	"title": "سُورَةُ الفَلَقِ",
	"numChapter": 113,
	"numVerses": 5,
	"verses": [
		"قُلۡ أَعُوذُ بِرَبِّ ٱلۡفَلَقِ",
		"مِن شَرِّ مَا خَلَقَ",
		"وَمِن شَرِّ غَاسِقٍ إِذَا وَقَبَ",
		"وَمِن شَرِّ ٱلنَّفَّٰثَٰتِ فِي ٱلۡعُقَدِ",
		"وَمِن شَرِّ حَاسِدٍ إِذَا حَسَدَ"
	]
}

Ayah & Verse

mushaf.ayahs() // Array of total ayahs/verses of mushaf
mushaf.ayah(surah,ayah) // Ayah n of surah n
mushaf.verse(chapter,verse) // Verse n of chapter n

// Example
mushaf.ayah(1, 3)

// return
ملك يوم الدينِ

Juz

mushaf.juzs() // Array of all 30 juz
mushaf.juz(juz) // Juz n

Maqra & Section

mushaf.maqras() // All 8 maqras (1/8 of a juz) of the last selected juz (or 1 by default)
mushaf.maqra(juz,maqra) // Maqra n of juz n
mushaf.section(juz,section) // Section n of juz n

// Example
mushaf.maqra(30,1)

// return
{
  verse: { text: 'عم يتساءلون', number: 5653 },
  page: { start: 582, end: 584 }
}

Raw

mushaf.rawLine(line) // Raw line n of all pages of the mushaf (combined)

// Example 
mushaf.line(1, 3)

// return
الحمد لله رب العلمين ١

Useful methods

 generatePages(maqra, offset) // Get page numbers from n maqra with offset
 getJuzIndex(maqra) // Get juz by maqra number
 getMaqraIndex(maqra) // Get maqra index

Source & licensing

Data is generated through mushafDatasetGenerator project. View the licensing on that project before deciding to use the data provided here.