AlQuran JS

A lightweight JavaScript/TypeScript library for accessing Quran data including Surahs, Ayat, and Juz.

📦 Installation

npm install alquran-js

or

pnpm add alquran-js

✨ Features

• Get a specific Ayah
• Get full Surah or partial range
• Get Juz data
• Get number of Ayat in a Surah
• Get Revelation place of Surah
• Fully TypeScript supported

🚀 Usage

import {
  getAyah,
  getSurah,
  getJuz,
  getAyatCount,
  getRevelationPlace
} from "alquran-js";

📖 API Reference

getAyah

Get a specific Ayah by number.

getAyah(5);

Returns:

string

getSurah

Get all or part of a Surah.

getSurah(1);
getSurah(2, 1, 5);

Returns:

string[]

getJuz

Get all or part of a Juz.

getJuz(1);
getJuz(2, 1, 5);

Returns:

string[]

getAyatCount

getAyatCount(1);

Returns:

number

getRevelationPlace

getRevelationPlace(1);

Returns:

string

⚠️ Errors

Throws errors on invalid input:

• Invalid surah number
• Invalid ayah number
• Invalid juz number

📜 License

MIT