Merge pull request #6 from quran/enable-hizb-verses

feat: enable verses by hizb API
quran · Oct 31, 2022 · b6602ab · b6602ab · vercel · Oct 31, 2022
2 parents b2d2eda + 420b4fe
commit b6602ab
Show file tree

Hide file tree

Showing 4 changed files with 4,953 additions and 4,911 deletions.
diff --git a/docs/pages/verses.mdx b/docs/pages/verses.mdx
@@ -109,3 +109,25 @@ Get a random ayah.
 ```js
 quran.v4.verses.findRandom()
 ```
+
+## findByHizb
+
+Get all ayahs of a specific Hizb.
+
+- [Quran.com API Docs](https://quran.api-docs.io/v4/verses/by-hizb-number)
+
+**Params:**
+
+`verses.findByHizb(id: HizbNumber, options?: GetVerseOptions)`
+
+| Param   | Type                         | Description       |
+| ------- | ---------------------------- | ----------------- |
+| page    | <code>HizbNumber</code>      | Quran Hizb number |
+| options | <code>GetVerseOptions</code> |                   |
+
+**Example:**
+
+```js
+quran.v4.verses.findByHizb('1')
+quran.v4.verses.findByHizb('60')
+```
diff --git a/src/sdk/v4/verses.ts b/src/sdk/v4/verses.ts
@@ -1,6 +1,6 @@
 import {
   ChapterId,
-  // HizbNumber,
+  HizbNumber,
   JuzNumber,
   Language,
   PageNumber,
@@ -146,7 +146,6 @@ const findByJuz = async (juz: JuzNumber, options?: GetVerseOptions) => {
   return verses;
 };
 
-// TODO: uncomment when API is fixed
 /**
  * Get all ayahs for a Hizb.
  * @description https://quran.api-docs.io/v4/verses/by-hizb-number
@@ -156,15 +155,15 @@ const findByJuz = async (juz: JuzNumber, options?: GetVerseOptions) => {
  * quran.v4.verses.findByHizb('1')
  * quran.v4.verses.findByHizb('29')
  */
-// const findByHizb = async (hizb: HizbNumber, options?: GetVerseOptions) => {
-//   if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
+const findByHizb = async (hizb: HizbNumber, options?: GetVerseOptions) => {
+  if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
 
-//   const params = getVerseOptions(options);
-//   const url = `/verses/by_hizb/${hizb}`;
-//   const { verses } = await fetcher<{ verses: Verse[] }>(url, params);
+  const params = getVerseOptions(options);
+  const url = `/verses/by_hizb/${hizb}`;
+  const { verses } = await fetcher<{ verses: Verse[] }>(url, params);
 
-//   return verses;
-// };
+  return verses;
+};
 
 // TODO: uncomment when API is fixed
 /**
@@ -205,7 +204,7 @@ const verses = {
   findByChapter,
   findByPage,
   findByJuz,
-  // findByHizb,
+  findByHizb,
   // findByRub,
   findRandom,
 };

diff --git a/test/verses.test.ts b/test/verses.test.ts
@@ -27,6 +27,13 @@ createApiTest('verses', {
     rejectParams: ['0' as any],
   },
   findRandom: {},
+  findByHizb: {
+    expect: {
+      array: true,
+    },
+    params: ['1'],
+    rejectParams: ['0' as any],
+  },
 });
 
-// TODO: test findByHizb and findByRub when fixed
+// TODO: test findByRub when fixed