Skip to content

Commit efd77f9

Browse files
ahmedriad1ahmedriad1
committed
docs: update qdc docs url & add missing docs for new methods
1 parent b464275 commit efd77f9

File tree

9 files changed

+147
-47
lines changed

9 files changed

+147
-47
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ you can visit the [docs][docs] for more details.
2929

3030
<!-- Links -->
3131

32-
[qdc-api]: https://api-docs.quran.com/docs/category/quran.com-api
32+
[qdc-api]: https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/quran-com-api
3333
[docs]: https://quranjs.vercel.app/
3434
[build-badge]: https://github.com/quran/api-js/workflows/CI/badge.svg
3535
[build]: https://github.com/quran/api-js/actions?query=workflow%3ACI

‎docs/src/pages/audio.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Get all chapter recitations for specific reciter.
44

5-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/list-of-all-surah-audio-files-for-specific-reciter)
5+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-reciter-audio-files)
66

77
**Params:**
88

@@ -23,7 +23,7 @@ quran.v4.audio.findAllChapterRecitations('2'); // abdulbaset abdulsamad
2323

2424
Get chapter recitation for specific reciter and a specific chapter.
2525

26-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-single-surah-audio-for-specific-reciter)
26+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-reciter-audio-file)
2727

2828
**Params:**
2929

@@ -45,7 +45,7 @@ quran.v4.audio.findChapterRecitationById('1', '2'); // first chapter recitation
4545

4646
Get all verse audio files for a specific reciter and a specific chapter.
4747

48-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-surah)
48+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-surah-recitation)
4949

5050
**Params:**
5151

@@ -67,7 +67,7 @@ quran.v4.audio.findVerseRecitationsByChapter('1', '2');
6767

6868
Get all verse audio files for a specific reciter and a specific hizb.
6969

70-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-hizb)
70+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-hizb-recitaiton)
7171

7272
**Params:**
7373

@@ -89,7 +89,7 @@ quran.v4.audio.findVerseRecitationsByHizb('1', '2');
8989

9090
Get all verse audio files for a specific reciter and a specific juz.
9191

92-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-juz)
92+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-juz-recitaiton)
9393

9494
**Params:**
9595

@@ -111,7 +111,7 @@ quran.v4.audio.findVerseRecitationsByJuz('1', '2');
111111

112112
Get all verse audio files for a specific reciter and a specific verse.
113113

114-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-ayah)
114+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-ayah-recitaiton)
115115

116116
**Params:**
117117

@@ -133,7 +133,7 @@ quran.v4.audio.findVerseRecitationsByKey('1:1', '2');
133133

134134
Get all verse audio files for a specific reciter and a specific mushaf page.
135135

136-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-madani-mushaf-page)
136+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-page-recitaiton)
137137

138138
**Params:**
139139

@@ -155,7 +155,7 @@ quran.v4.audio.findVerseRecitationsByPage('1', '2');
155155

156156
Get all verse audio files for a specific reciter and a specific rub.
157157

158-
- [Quran.com API Docs](https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-rub)
158+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-rub-el-hizb-recitaiton)
159159

160160
**Params:**
161161

‎docs/src/pages/chapters.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Get all chapters.
44

5-
- [Quran.api API Docs](https://quran.api-docs.io/v4/chapters/list-chapters)
5+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/list-chapters)
66

77
**Params:**
88

@@ -22,7 +22,7 @@ quran.v4.chapters.findAll();
2222

2323
Get chapter by id.
2424

25-
- [Quran.com API Docs](https://quran.api-docs.io/v4/chapters/get-chapter)
25+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/get-chapter)
2626

2727
**Params:**
2828

@@ -44,7 +44,7 @@ quran.v4.chapters.findById('114');
4444

4545
Get chapter info by id.
4646

47-
- [Quran.com API Docs](https://quran.api-docs.io/v4/chapters/chapter_info)
47+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/info)
4848

4949
**Params:**
5050

‎docs/src/pages/index.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,20 @@ import { Tab, Tabs } from 'nextra-theme-docs';
33

44
<Image src="/banner.png" alt="QuranJS/API Banner" width={1280} height={680} />
55

6-
A library for fetching quran data from the [Quran.com API](https://quran.api-docs.io/). This library also works on both Node.js and the browser.
6+
A library for fetching quran data from the [Quran.com API](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/quran-com-api). This library also works on both Node.js and the browser.
77

88
- [NPM](https://www.npmjs.com/package/@quranjs/api)
99
- [MIT License](https://github.com/quran/api-js/blob/master/LICENSE)
1010

1111
## Installation
1212

1313
{/* prettier-ignore-start */}
14-
<Tabs items={['npm', 'yarn']}>
14+
<Tabs items={['pnpm', 'npm', 'yarn','CDN']}>
15+
<Tab>
16+
```bash
17+
pnpm add @quranjs/api
18+
```
19+
</Tab>
1520
<Tab>
1621
```bash
1722
npm install @quranjs/api
@@ -22,6 +27,16 @@ A library for fetching quran data from the [Quran.com API](https://quran.api-doc
2227
yarn add @quranjs/api
2328
```
2429
</Tab>
30+
<Tab>
31+
```html
32+
<script src="https://unpkg.com/@quranjs/api/dist/index.umd.min.js"></script>
33+
<script>
34+
// quranjsApi is the global variable set by the script tag
35+
const { quran } = window.quranjsApi;
36+
quran.v4.chapters.findAll().then(console.log); // log all chapters
37+
</script>
38+
```
39+
</Tab>
2540
</Tabs>
2641
{/* prettier-ignore-end */}
2742

‎docs/src/pages/juzs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Get All Juzs
44

5-
- [Quran.com API Docs](https://quran.api-docs.io/v4/juz/get-all-juzs)
5+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/juzs)
66

77
**Example:**
88

‎docs/src/pages/resources.mdx

Lines changed: 71 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Get all chapter infos.
44

5-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/chapter-info)
5+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-info)
66

77
**Params:**
88

@@ -22,7 +22,7 @@ quran.v4.resources.findAllChapterInfos();
2222

2323
Get all chapter reciters.
2424

25-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/list-of-chapter-reciters)
25+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/chapter-reciters)
2626

2727
**Params:**
2828

@@ -42,7 +42,7 @@ quran.v4.resources.findAllChapterReciters();
4242

4343
Get all languages.
4444

45-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/languages)
45+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/languages)
4646

4747
**Params:**
4848

@@ -62,7 +62,7 @@ quran.v4.resources.findAllLanguages();
6262

6363
Get all recitations.
6464

65-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/recitations)
65+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/recitations)
6666

6767
**Params:**
6868

@@ -78,11 +78,32 @@ Get all recitations.
7878
quran.v4.resources.findAllRecitations();
7979
```
8080

81+
## findRecitationInfo
82+
83+
Get recitation info.
84+
85+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/recitation-info)
86+
87+
**Params:**
88+
89+
`resources.findRecitationInfo(id: string, options?: GetResourceOptions)`
90+
91+
| Param | Type |
92+
| ------- | -------------------- |
93+
| id | `string` |
94+
| options | `GetResourceOptions` |
95+
96+
**Example:**
97+
98+
```js
99+
quran.v4.resources.findRecitationInfo('1');
100+
```
101+
81102
## findAllRecitationStyles
82103

83104
Get all recitation styles.
84105

85-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/recitation-styles)
106+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/recitation-styles)
86107

87108
**Example:**
88109

@@ -94,7 +115,7 @@ quran.v4.resources.findAllRecitationStyles();
94115

95116
Get all tafsirs.
96117

97-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/tafsirs)
118+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/tafsirs)
98119

99120
**Params:**
100121

@@ -110,11 +131,32 @@ Get all tafsirs.
110131
quran.v4.resources.findAllTafsirs();
111132
```
112133

134+
## findTafsirInfo
135+
136+
Get tafsir info.
137+
138+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/tafsir-info)
139+
140+
**Params:**
141+
142+
`resources.findTafsirInfo(id: string, options?: GetResourceOptions)`
143+
144+
| Param | Type |
145+
| ------- | -------------------- |
146+
| id | `string` |
147+
| options | `GetResourceOptions` |
148+
149+
**Example:**
150+
151+
```js
152+
quran.v4.resources.findTafsirInfo('1');
153+
```
154+
113155
## findAllTranslations
114156

115157
Get all translations.
116158

117-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/translations)
159+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/translations)
118160

119161
**Params:**
120162

@@ -130,11 +172,32 @@ Get all translations.
130172
quran.v4.resources.findAllTranslations();
131173
```
132174

175+
## findTranslationInfo
176+
177+
Get all translations.
178+
179+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/translation-info)
180+
181+
**Params:**
182+
183+
`resources.findTranslationInfo(id: string, options?: GetResourceOptions)`
184+
185+
| Param | Type |
186+
| ------- | -------------------- |
187+
| id | `string` |
188+
| options | `GetResourceOptions` |
189+
190+
**Example:**
191+
192+
```js
193+
quran.v4.resources.findTranslationInfo('169');
194+
```
195+
133196
## findVerseMedia
134197

135198
Get verse media.
136199

137-
- [Quran.com API Docs](https://quran.api-docs.io/v4/resources/verse_media)
200+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/verse-media)
138201

139202
**Params:**
140203

‎docs/src/pages/search.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## search
22

3-
- [Quran.com API Docs](https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj)
3+
- [Quran.com API Docs](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/search)
44

55
**Params:**
66

‎docs/src/pages/techniques.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Custom fetcher
22

3-
By default, all functions that interact with the [Quran.com API](https://quran.api-docs.io/v4) use the global `fetch` function.
3+
By default, all functions that interact with the [Quran.com API](https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/quran-com-api) use the global `fetch` function.
44

55
You can override this by passing a custom fetcher (as `fetchFn`) to the options object of any method.
66

0 commit comments

Comments
 (0)