Skip to content
node,websql and javascript API for Holy quran
JavaScript Shell
Find file
Latest commit 1f425c4 Sep 26, 2015 @qzaidi bump
Failed to load latest commit information.
contrib make work Feb 21, 2013
data make work Feb 21, 2013
quran doc, expose text as well Sep 26, 2015
scripts add hindi and urdu translations Mar 2, 2013
test add juz support Sep 23, 2014
.gitignore 0.0.2 - with english translation. Feb 24, 2013
.npmignore 0.0.2 - with english translation. Feb 24, 2013
README.md doc, expose text as well Sep 26, 2015
index.js initial create Feb 21, 2013
package.json bump Sep 26, 2015

README.md

quran

node.js interface to Holy Quran. See the javascript and websql versions at http://qzaidi.github.io/quran.

Installation

npm install quran

Usage

var quran = require('quran');

Fetch the first verse of second chapter

quran.get(2,1,function(err,verse) {
  if (!err) {
    console.log('Verse 1: Chapter 1: ' + verse.arabic);
  }
});

Fetch the first chapter

quran.get(1,function(err,verses) {
  if (!err) {
    console.log('Chapter 1: ' + verses.join(','));
  }
});

verses is an array, so you can join them in the above.

.get is simply a wrapper on select, so you can directly invoke it and do advanced filtering, like getting verse 2-4 of first chapter.

quran.select({ chapter: 1}, { offset: 1, limit: 3}, function(err,verses) {
  if (!err) {
    console.log(verses);
  }
});

[
  { chapter: 1,
    verse: 1,
    ar: 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ' },
  { chapter: 1,
    verse: 2,
    ar: 'ٱلْحَمْدُ لِلَّهِ رَبِّ ٱلْعَٰلَمِينَ' },
  { chapter: 1, verse: 3, ar: 'ٱلرَّحْمَٰنِ ٱلرَّحِيمِ' } 
]

verses is an array of objects, and has additional info (chapter number, verse number).

The second argument to select is optional.

If you want to fetch multiple verses, not necessarily in sequence, use an array to specify this.

quran.select({ chapter: 1, verse: [ 2, 4, 6 ]}, function(err,verses) {
  if (!err) {
    console.log(verses);
  }
});

[ { chapter: 1,
    verse: 2,
    ar: 'ٱلْحَمْدُ لِلَّهِ رَبِّ ٱلْعَٰلَمِينَ'
  },
  { 
    chapter: 1, 
    verse: 4, 
    ar: 'مَٰلِكِ يَوْمِ ٱلدِّينِ' 
  },
  { chapter: 1,
    verse: 6,
    ar: 'ٱهْدِنَا ٱلصِّرَٰطَ ٱلْمُسْتَقِيمَ'
  } 
]

Currently, only arabic text and english, hindi and urdu translations are supported, to limit package size. You can however, easily add translations to this package. Open an issue if you want to.

To fetch both the arabic text and translation, set the language option to en.

quran.select({ chapter: 1}, { offset: 1, limit: 3, language: 'en'}, function(err,verses) {
  if (!err) {
    console.log(verses);
  }
});

Similarly for hindi

Code:
quran.select({ chapter: 1}, { offset: 1, limit: 3, language: 'hi'}, function(err,verses) {
  if (!err) {
    console.log(verses);
  }
});
Output
[ 
  { chapter: 1,
    verse: 1,
    ar: 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ',
    hi: 'अल्लाह के नाम से जो रहमान व रहीम है।',
    translator: 'hindi' },
  { chapter: 1,
    verse: 2,
    ar: 'ٱلْحَمْدُ لِلَّهِ رَبِّ ٱلْعَٰلَمِينَ',
    hi: 'तारीफ़ अल्लाह ही के लिये है जो तमाम क़ायनात का रब है।',
    translator: 'hindi' },
  { chapter: 1,
    verse: 3,
    ar: 'ٱلرَّحْمَٰنِ ٱلرَّحِيمِ',
    hi: 'रहमान और रहीम है।',
    translator: 'hindi' } 
]

Want multiple translations at once? Use an array when specifying language

quran.select({ chapter: 1, verse: [ 2, 4, 6 ]}, 
             { language: ['ur', 'en ] }, function(err,verses) {
  if (!err) {
    console.log(verses);
  }
});

[ { chapter: 1,
    verse: 2,
    ar: 'ٱلْحَمْدُ لِلَّهِ رَبِّ ٱلْعَٰلَمِينَ',
    en: 'All praise is due to Allah, the Lord of the Worlds.',
    ur: 'ساری تعریف اللہ کے لئے ہے جو عالمین کا پالنے والا ہے'
  },
  { chapter: 1,
    verse: 4,
    ar: 'مَٰلِكِ يَوْمِ ٱلدِّينِ',
    en: 'Master of the Day of Judgment.',
    ur: 'روزِقیامت کا مالک و مختار ہے' 
  },
  { chapter: 1,
    verse: 6,
    ar: 'ٱهْدِنَا ٱلصِّرَٰطَ ٱلْمُسْتَقِيمَ',
    en: 'Keep us on the right path.',
    ur: 'ہمیں سیدھے راستہ کی ہدایت فرماتا رہ' 
  } 
] 

You can also fetch meta data about a chapter

quran.chapter(1,function(err,info) {
  if (!err) {
    console.log(info);
  }
});

Or all the chapters, by omitting the optional argument

quran.chapter(function(err,info) {
  if (!err) {
    console.log(info);
  }
});

To access by juz, for example, first 10 verses of juz 28, use this pattern

quran.juz(28,function(err,j) {
  console.log(err || j[0]);
  if (!err) {
    quran.select({ chapter: j[0].surah }, { offset: j[0].ayah-1, limit: 10 }, function(err,verses) {
      console.log(err || verses);
    });
  }
});

To search in a translation, use the search API

quran.search('en','islam',function(err,verses) {
  // verses is an array of verses matching 'islam'
});

TODO

The npm module stores quran db as a sqlite database and exposes it via an API. With webSQL, it should be possible to do the same for a pure javascript application, without requiring a server side component. That's the idea behind Quran browser, and it might be interesting to make a websql version available which supports the same API in browser.

Credits

This work is based on Quran Text and Translations made available by http://tanzil.net.

Sites using this package

http://duas.mobi/quran.

To add yours, submit a pull request.

Something went wrong with that request. Please try again.