0.0.1 • Published 9 months ago

react-hadiths v0.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
9 months ago

React-hadiths

This SDK supplies easy access to Hadiths - API resources.

Features

This is a a list of unique features this project comprise of;

  • Get all hadiths
  • Get a single hadith
  • Get hadiths by collection
  • TCategorized hadiths by categories and collection
  • Easy to search and limit the number of hadiths

How to use

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Install NPM package

    npm install react-hadiths
    
    yarn react-hadiths
  2. Visit to subscribe free of charge, no atm required. Hadiths API.

  3. Usage Get all hadiths

     import Hadith from "react-hadiths"
         const client = new Hadith({
             apiKey: "ENTER YOUR API KEY"
         });
         client.getAlltHadiths().then((item) => 
             console.log(item)
         )

Get a single Hadith by ID

 import Hadith from "react-hadiths"
     const client = new Hadith({
         apiKey: "ENTER YOUR API KEY"
     });
     let id ="639b1ed040467f67664485cb"
     client.getHadithById(id).then((item) => 
         console.log(item)
     )

Get Hadith by collection

 import Hadith from "react-hadiths"
     const client = new Hadith({
         apiKey: "ENTER YOUR API KEY"
     });
     let collection ="Sahih Muslim"
     client.getHadithsByCollection(collection).then((item) => 
         console.log(item)
     )

Get Hadith by category and collection

 import Hadith from "react-hadiths"
     const client = new Hadith({
         apiKey: "ENTER YOUR API KEY"
     });
     let collection ="Sahih Muslim"
     let category ="Introduction"
     client.getHadithsByCategory(collection, category).then((item) => 
         console.log(item)
     )

Search for words

 import Hadith from "react-hadiths"
     const client = new Hadith({
         apiKey: "ENTER YOUR API KEY"
     });
     let search ="food"
     client.searchHadiths(search).then((item) => 
         console.log(item)
     )

Learn More

You can learn more in the Hadiths API. Visit the Github.