1.2.3 • Published 1 year ago
quran-db v1.2.3
Quran text, translation, audio URLs, and details of pages, juz, surah, ayah, place of revelation etc.
Constants:
basmala
- The constant 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ'sajdah
- The constant 'سَجْدَةٌ'totalJuzCount
- The constant total juz counttotalMadaniSurahs
- The constant total of madani surahstotalMakkiSurahs
- The constant total of makki surahstotalPagesCount
- The most standard and common copy of Arabic only Quran total pages counttotalSurahCount
- The constant total surah counttotalVerseCount
- The constant total verse count
Functions:
Juz:
getJuzNumber(surahNumber, verseNumber)
- Takes surahNumber & verseNumber and returns Juz numbergetSurahAndVersesFromJuz(juzNumber)
- Takes juzNumber and returns a map containing Surah and Verse numbers
Surah:
getSurahName(surahNumber)
- Takes surahNumber and returns the Surah namegetSurahNameArabic(surahNumber)
- Takes surahNumber returns the Surah name in ArabicgetSurahNameEnglish(surahNumber)
- Takes surahNumber returns the Surah name in EnglishgetSurahNameTurkish(surahNumber)
- Takes surahNumber returns the Surah name in TurkishgetPlaceOfRevelation(surahNumber)
- Takes surahNumber and returns the Place of Revelation (Makkah / Madinah) of that SurahgetVerseCount(surahNumber)
- Takes surahNumber and returns the count of total Verses in that Surah
Verse:
getVerse(surahNumber, verseNumber, {verseEndSymbol})
- Takes surahNumber, verseNumber & verseEndSymbol and returns the Verse in ArabicgetVerseEndSymbol(verseNumber, {arabicNumeral})
- Takes verseNumber, arabicNumeral and returns '' symbol with verse numberisSajdahVerse(surahNumber, verseNumber)
- Takes surahNumber, verseNumber and returns true if verse is sajdah versegetVerseTranslation(surahNumber, verseNumber, {verseEndSymbol, translation})
- Takes surahNumber, verseNumber, verseEndSymbol & translation and returns verse translation
Page:
getPageData(pageNumber)
- Takes pageNumber and returns a list containing Surahs and the starting and ending Verse numbers in that pagegetPageNumber(surahNumber, verseNumber)
- Takes surahNumber, verseNumber and returns the page number of the QurangetSurahCountByPage(pageNumber)
- Takes pageNumber and returns total surahs count in that pagegetSurahPages(surahNumber)
- Takes surahNumber and returns the list of page numbers of that surahgetVerseCountByPage(pageNumber)
- Takes pageNumber and returns total verses count in that pagegetVersesTextByPage(pageNumber, {verseEndSymbol, surahSeperator, customSurahSeperator})
- Takes pageNumber, verseEndSymbol, surahSeperator & customSurahSeperator and returns the list of verses in that page
URLs:
getAudioURLBySurah(surahNumber)
- Takes surahNumber and returns audio URL of that surahgetAudioURLByVerse(surahNumber, verseNumber)
- Takes surahNumber & verseNumber and returns audio URL of that versegetAudioURLByVerseNumber(surahNumber)
- Takes verseNumber and returns audio URL of that versegetJuzURL(juzNumber)
- Takes juzNumber and returns Juz URL (from Quran.com)getSurahURL(surahNumber)
- Takes surahNumber and returns Surah URL (from Quran.com)getVerseURL(surahNumber, verseNumber)
- Takes surahNumber & verseNumber and returns Verse URL (from Quran.com)
Search:
searchWords(words)
- Takes an array of words words and returns a map containing no. of occurences and result of the word search in the arabic quran textsearchWordsInTranslation(words, {translation})
- Takes an array of words words and translation and returns a map containing no. of occurences and result of the word search in the traslation
Translations:
- English (Saheeh International) -
Translation.enSaheeh
- Turkish -
Translation.trSaheeh
- Malayalam (Cheriyamundam Abdul Hameed and Kunhi Mohammed Parappoor) -
Translation.mlAbdulHameed
SurahSeperators:
SurahSeperator.none
SurahSeperator.surahName
SurahSeperator.surahNameArabic
SurahSeperator.surahNameEnglish
SurahSeperator.surahNameTurkish