Quran Sharif

A utility package for working with the Quran in JavaScript.

Features

• Retrieve all surahs from the Quran.
• Get a specific surah by ID.
• Retrieve a list of surah names.
• Filter surahs by revelation type.
• Fetch ayahs by Juz ID.

Installation

Install the package using npm:

npm install quran_sharif

Usage

Import the package into your JavaScript file:

const quran = require('quran_sharif');

Use the provided methods to access the Quran data:

// Retrieve all surahs
const allSurahs = quran.getAllSurah();

// Get surah by ID
const surah = quran.getSurahById({ id: 1 });

// Get a list of surah names
const surahNames = quran.getSurahName();

// Filter surahs by revelation type
const makkiSurahs = quran.getSurahByRevelationType({ isMakki: true });

// Get ayahs by Juz ID
const juzAyahs = quran.getJuz({ id: 1 });

For more details on each method and its usage, refer to the API documentation.

Examples

You can find usage examples in the examples folder of this repository.

API Documentation

The API documentation for this package can be found here.

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.

Author

This package is authored and maintained by zaid.digital.

Get in touch

If you have any questions, feel free to reach out:

• Email: [e-mail]
• GitHub: @MohamedAshraf701