Skip to content

Latest commit

 

History

History
252 lines (138 loc) · 7.44 KB

README.md

File metadata and controls

252 lines (138 loc) · 7.44 KB
Raw

al-quran-sdk

A TypeScript SDK for accessing various resources related to the Quran, including verses, chapters, audio recitations, translations, and more. This SDK provides a comprehensive set of APIs to interact with Quran data and resources efficiently.

Table of Contents

Installation

To install the SDK, use npm or yarn or pnpm:

npm install al-quran-sdk
# or
yarn add al-quran-sdk
#  or
pnpm install al-quran-sdk

API Documentation

Verse API

Provides methods to fetch verses based on various criteria.

getVerseByChapter(chapter_number: string, query?: VerseQuery): Promise<VerseResponse>

Fetches verses by chapter number.

getVerseByPage(page_number: string, query?: VerseQuery): Promise<VerseResponse>

Fetches verses by page number.

getVerseByJuz(juz_number: string, query?: VerseQuery): Promise<VerseResponse>

Fetches verses by Juz number.

getVerseByHizbNumber(hizb_number: string, query?: VerseQuery): Promise<VerseResponse>

Fetches verses by Hizb number.

getVerseByRubElHizbNumber(rub_el_hizb_number: string, query?: VerseQuery): Promise<VerseResponse>

Fetches verses by Rub el Hizb number.

getSpecificVerseByVerseKey(verse_key: string, query?: VerseQuery): Promise<VerseResponse>

Fetches a specific verse by its key.

getRandomAyah(query?: VerseQuery): Promise<VerseResponse>

Fetches a random verse.

Resources API

Provides methods to fetch resource information.

getRecitationInfo(recitation_id: string): Promise<RecitationInfo>

Fetches information about a specific recitation.

getTranslationInfo(translation_id: string): Promise<TranslationInfo>

Fetches information about a specific translation.

getTranslations(language: string = 'en'): Promise<TranslationResponse>

Fetches translations based on language.

getTafsirs(language: string = 'en'): Promise<TafsirsResponse>

Fetches Tafsirs based on language.

getTafsirInfo(tafsir_id: string): Promise<TafsirInfoResponse>

Fetches information about a specific Tafsir.

getRecitationStyles(): Promise<RecitationStyleResponse>

Fetches available recitation styles.

getLanguages(): Promise<LanguageResponse>

Fetches available languages.

getChapterInfos(): Promise<ChapterInfos>

Fetches information about chapters.

getVerseMedias(): Promise<VerseMediaResponse>

Fetches media associated with verses.

Quran API

Provides methods to fetch Quranic text in various scripts.

getIndoPakScriptOfAyah(query?: QuranQuery): Promise<QuranResponse>

Fetches the Indo-Pak script of an Ayah.

getUthmaniTajweedScriptOfAyah(query?: QuranQuery): Promise<UthmaniTajweedResponse>

Fetches the Uthmani Tajweed script of an Ayah.

getUthmaniScriptOfAyah(query?: QuranQuery): Promise<UthmaniScriptResponse>

Fetches the Uthmani script of an Ayah.

getUthmaniSimpleScriptOfAyah(query?: QuranQuery): Promise<UthmaniSimpleScriptResponse>

Fetches the Uthmani simple script of an Ayah.

getImlaeiSimpleTextOfAyah(query?: QuranQuery): Promise<ImlaeiSimpleTextResponse>

Fetches the Imlaei simple text of an Ayah.

getASingleTranslation(translation_id: string, query?: TranslationQuery): Promise<SingleTranslationResponse>

Fetches a single translation.

getSingleTafsir(tafsir_id: string, query?: TranslationQuery): Promise<SingleTafsirResponse>

Fetches a single Tafsir.

getGlyphCodesOfAyahV1(query?: QuranQuery): Promise<GlyphCodesOfAyahV1Response>

Fetches glyph codes of an Ayah (version 1).

getGlyphCodesOfAyahV2(query?: QuranQuery): Promise<GlyphCodesOfAyahV2Response>

Fetches glyph codes of an Ayah (version 2).

Juz API

Provides methods to fetch information about Juz.

getAllJuzs(): Promise<JuzResponse>

Fetches all Juz.

Chapter API

Provides methods to fetch chapter information.

listChapters(language = 'en'): Promise<ListChapters>

Fetches a list of chapters based on language.

getChapter(id: number, language = 'en'): Promise<Chapter>

Fetches information about a specific chapter.

getChapterInfo(chapter_id: number, language = 'en'): Promise<ChapterInfo>

Fetches detailed information about a specific chapter.

Audio API

Provides methods to fetch audio recitations and related data.

getChaptersAudioOfAReciter(id: number, chapter_number: number): Promise<IAudio>

Fetches audio recordings of a specific chapter by a particular reciter.

getAllChaptersAudioOfAReciter(id: number): Promise<IListOfAllAudioOfAReciter>

Fetches all chapter recordings by a specific reciter.

getRecitations(language: string = 'en'): Promise<IRecitation>

Fetches recitations based on language.

getAllAudioFilesofARecitation(recitation_id: number, query?: AudioQueryParams): Promise<ISingleRecitation>

Fetches all audio files of a specific recitation.

getListOfChapterReciters(language: string = 'en'): Promise<IReciters>

Fetches a list of chapter reciters based on language.

getAyahRecitationsForSpecificSurah(recitation_id: number, chapter_number: number): Promise<IAyahRecitationSpecificSurah>

Fetches Ayah recitations for a specific Surah.

getAyahRecitationsForSpecificJuz(recitation_id: number, juz_number: number): Promise<IAyahRecitationSpecificJuz>

Fetches Ayah recitations for a specific Juz.

getAyahRecitationForSpecificMadaniMushafPage(recitation_id: number, page_number: number): Promise<IAyahRecitationSpecificMadaniMushafPage>

Fetches Ayah recitations for a specific Madani Mushaf page.

getAyahRecitationForSpecificRubelHizb(recitation_id: number, rub_el_hizb_number: number): Promise<IAyahRecitationSpecificRubelHizb>

Fetches Ayah recitations for a specific Rub el Hizb.

getAyahRecitationForSpecificHizb(recitation_id: number, hizb_number: number): Promise<IAyahRecitationSpecificHizb>

Fetches Ayah recitations for a specific Hizb.

getAyahRecitationForSpecificAyah(recitation_id: number, ayah_key: string): Promise<IAyahRecitationSpecificAyah>

Fetches Ayah recitations for a specific Ayah.

Usage

Here's a basic example of how to use the SDK:

Usage in a CommonJS Environment:

const { chapter } = require("al-quran-sdk");

chapter.listChapters('en')
    .then((res) => console.log(res))
    .catch((err) => console.error(err));

ES6+ (ECMAScript Modules)

import { chapter }  from "al-quran-sdk";

chapter.listChapters('en')
    .then((res) => console.log(res))
    .catch((err) => console.error(err));

Contributing

Contributions are welcome! Please follow the standard GitHub fork-and-pull request workflow. If you have suggestions or improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Inclusivity and Neutrality

This SDK aims to be inclusive and respectful of all religions and beliefs. The Quran is a central text in Islam, and this SDK is designed to provide access to Quranic data for educational and informational purposes. I strive to present facts and information neutrally and inclusively, and welcome feedback to improve my approach.