@quranjs/api 1.1.3 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/README.md +7 -0
  2. package/dist/api.cjs.development.js +2723 -0
  3. package/dist/api.cjs.development.js.map +1 -0
  4. package/dist/api.cjs.production.min.js +2 -0
  5. package/dist/api.cjs.production.min.js.map +1 -0
  6. package/dist/api.esm.js +2715 -0
  7. package/dist/api.esm.js.map +1 -0
  8. package/dist/index.d.ts +2 -0
  9. package/dist/index.js +8 -0
  10. package/dist/sdk/index.d.ts +183 -0
  11. package/dist/sdk/utils.d.ts +125 -0
  12. package/dist/sdk/v4/_fetcher.d.ts +3 -0
  13. package/dist/sdk/v4/audio.d.ts +52 -0
  14. package/dist/sdk/v4/chapters.d.ts +13 -0
  15. package/dist/sdk/v4/index.d.ts +173 -0
  16. package/dist/sdk/v4/juzs.d.ts +5 -0
  17. package/dist/sdk/v4/resources.d.ts +26 -0
  18. package/dist/sdk/v4/search.d.ts +22 -0
  19. package/dist/sdk/v4/verses.d.ts +64 -0
  20. package/dist/types/ChapterId.d.ts +1 -0
  21. package/dist/types/HizbNumber.d.ts +1 -0
  22. package/dist/types/JuzNumber.d.ts +1 -0
  23. package/dist/types/PageNumber.d.ts +1 -0
  24. package/dist/types/RubNumber.d.ts +1 -0
  25. package/dist/types/VerseKey.d.ts +1 -0
  26. package/dist/types/api/ApiResponses.d.ts +18 -0
  27. package/dist/types/api/AudioData.d.ts +17 -0
  28. package/dist/types/api/AudioResponse.d.ts +8 -0
  29. package/dist/types/api/Chapter.d.ts +14 -0
  30. package/dist/types/api/ChapterInfo.d.ts +8 -0
  31. package/dist/types/api/Footnote.d.ts +6 -0
  32. package/dist/types/api/Juz.d.ts +8 -0
  33. package/dist/types/api/Pagination.d.ts +7 -0
  34. package/dist/types/api/Reciter.d.ts +21 -0
  35. package/dist/types/api/Resources.d.ts +70 -0
  36. package/dist/types/api/Segment.d.ts +4 -0
  37. package/dist/types/api/Tafsir.d.ts +7 -0
  38. package/dist/types/api/TafsirInfo.d.ts +9 -0
  39. package/dist/types/api/TranslatedName.d.ts +4 -0
  40. package/dist/types/api/Translation.d.ts +17 -0
  41. package/dist/types/api/Transliteration.d.ts +4 -0
  42. package/dist/types/api/Verse.d.ts +32 -0
  43. package/dist/types/api/Word.d.ts +28 -0
  44. package/dist/types/api/index.d.ts +18 -0
  45. package/dist/types/index.d.ts +88 -0
  46. package/dist/utils/misc.d.ts +1 -0
  47. package/dist/utils/qs-stringify.d.ts +21 -0
  48. package/package.json +1 -3
  49. package/src/sdk/v4/_fetcher.ts +2 -2
  50. package/src/sdk/v4/audio.ts +1 -1
  51. package/src/sdk/v4/chapters.ts +1 -1
  52. package/src/sdk/v4/juzs.ts +1 -1
  53. package/src/sdk/v4/resources.ts +1 -1
  54. package/src/sdk/v4/search.ts +1 -1
  55. package/src/sdk/v4/verses.ts +1 -1
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  ![Quranjs Api Header](https://github.com/quranjs/api/raw/master/media/repo-header.png)
2
2
  A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.
3
3
 
4
+ [Checkout Docs][docs]
5
+
4
6
  [![Build Status][build-badge]][build]
5
7
  [![MIT License][license-badge]][license]
6
8
  [![NPM Version][npm-badge]][npm]
@@ -21,9 +23,14 @@ using yarn:
21
23
  yarn add @quranjs/api
22
24
  ```
23
25
 
26
+ ## Getting Started
27
+
28
+ you can visit the [docs][docs] for more details.
29
+
24
30
  <!-- Links -->
25
31
 
26
32
  [qdc-api]: https://quran.api-docs.io/
33
+ [docs]: https://quranjs.vercel.app/
27
34
  [build-badge]: https://github.com/quranjs/api/workflows/CI/badge.svg
28
35
  [build]: https://github.com/quranjs/api/actions?query=workflow%3ACI
29
36
  [license-badge]: https://badgen.net/github/license/quranjs/api