npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mushaf

v0.0.8

Published

A mushaf library

Downloads

3

Readme

Contents

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.