@quranjs/api 1.3.0 → 1.4.0

package/dist/api.esm.js

@@ -1312,7 +1312,7 @@ var getChapterOptions = function getChapterOptions(options) {
 /**
  * Get all chapters.
  * @description https://quran.api-docs.io/v4/chapters/list-chapters
- * @param {Options} options
+ * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findAll()
  */
@@ -1351,7 +1351,7 @@ var findAll$1 = /*#__PURE__*/function () {
  * Get chapter by id.
  * @description https://quran.api-docs.io/v4/chapters/get-chapter
  * @param {ChapterId} id chapter id, minimum 1, maximum 114
- * @param {Options} options
+ * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findById('1')
  * quran.v4.chapters.findById('114')
@@ -1399,7 +1399,7 @@ var findById = /*#__PURE__*/function () {
  * Get chapter info by id.
  * @description https://quran.api-docs.io/v4/chapters/chapter_info
  * @param {ChapterId} id chapter id, minimum 1, maximum 114
- * @param {Options} options
+ * @param {GetChapterOptions} options
  * @example
  * quran.v4.chapters.findInfoById('1')
  * quran.v4.chapters.findInfoById('114')
@@ -1882,7 +1882,7 @@ var getVerseRecitationsOptions = function getVerseRecitationsOptions(options) {
  * Get all chapter recitations for specific reciter
  * @description https://quran.api-docs.io/v4/audio-recitations/list-of-all-surah-audio-files-for-specific-reciter
  * @param {string} reciterId
- * @param {GetChapterRecitationsOptions} options
+ * @param {GetChapterRecitationOptions} options
  * @example
  * quran.v4.audio.findAllChapterRecitations('2')
  */
@@ -1922,7 +1922,7 @@ var findAllChapterRecitations = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-single-surah-audio-for-specific-reciter
  * @param {ChapterId} chapterId
  * @param {string} reciterId
- * @param {GetChapterRecitationsOptions} options
+ * @param {GetChapterRecitationOptions} options
  * @example
  * quran.v4.audio.findChapterRecitationById('1', '2') // first chapter recitation for reciter 2
  */
@@ -1970,7 +1970,7 @@ var findChapterRecitationById = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-surah
  * @param {ChapterId} chapterId
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByChapter('1', '2')
  */
@@ -2062,7 +2062,7 @@ var findVerseRecitationsByJuz = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-madani-mushaf-page
  * @param {PageNumber} page
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByPage('1', '2')
  */
@@ -2108,7 +2108,7 @@ var findVerseRecitationsByPage = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-rub
  * @param {RubNumber} rub
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByRub('1', '2')
  */
@@ -2154,7 +2154,7 @@ var findVerseRecitationsByRub = /*#__PURE__*/function () {
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-hizb
  * @param {HizbNumber} hizb
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByHizb('1', '2')
  */
@@ -2196,11 +2196,11 @@ var findVerseRecitationsByHizb = /*#__PURE__*/function () {
   };
 }();
 /**
- * Get all verse audio files for a specific reciter and a specific hizb
+ * Get all verse audio files for a specific reciter and a specific verse
  * @description https://quran.api-docs.io/v4/audio-recitations/get-ayah-recitations-for-specific-ayah
  * @param {VerseKey} key
  * @param {string} recitationId
- * @param {GetVerseRecitationsOptions} options
+ * @param {GetVerseRecitationOptions} options
  * @example
  * quran.v4.audio.findVerseRecitationsByKey('1:1', '2')
  */
@@ -2269,7 +2269,7 @@ var getResourcesOptions = function getResourcesOptions(options) {
 /**
  * Get all recitations.
  * @description https://quran.api-docs.io/v4/resources/recitations
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllRecitations()
  */
@@ -2309,11 +2309,11 @@ var findAllRecitations = /*#__PURE__*/function () {
  * Get all recitation info.
  * @description https://quran.api-docs.io/v4/resources/recitation-info
  * @param {string} id recitation id
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findRecitationInfo('1')
  */
-// const findRecitationInfo = async (id: string, options?: GetResourcesOptions) => {
+// const findRecitationInfo = async (id: string, options?: GetResourceOptions) => {
 //   const params = getResourcesOptions(options);
 //   const { info } = await fetcher<{
 //     info: RecitationInfoResource;
@@ -2324,7 +2324,7 @@ var findAllRecitations = /*#__PURE__*/function () {
 /**
  * Get all translations.
  * @description https://quran.api-docs.io/v4/resources/translations
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTranslations()
  */
@@ -2364,11 +2364,11 @@ var findAllTranslations = /*#__PURE__*/function () {
  * Get translation info.
  * @description https://quran.api-docs.io/v4/resources/translation-info
  * @param {string} id translation id
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findTranslationInfo('169')
  */
-// const findTranslationInfo = async (id: string, options?: GetResourcesOptions) => {
+// const findTranslationInfo = async (id: string, options?: GetResourceOptions) => {
 //   const params = getResourcesOptions(options);
 //   const { info } = await fetcher<{
 //     info: TranslationInfoResource;
@@ -2379,7 +2379,7 @@ var findAllTranslations = /*#__PURE__*/function () {
 /**
  * Get all tafsirs.
  * @description https://quran.api-docs.io/v4/resources/tafsirs
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllTafsirs()
  */
@@ -2419,11 +2419,11 @@ var findAllTafsirs = /*#__PURE__*/function () {
  * Get tafsir info.
  * @description https://quran.api-docs.io/v4/resources/tafsirs-info
  * @param {string} id tafsir id
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findTranslationInfo('1')
  */
-// const findTafsirInfo = async (id: string, options?: GetResourcesOptions) => {
+// const findTafsirInfo = async (id: string, options?: GetResourceOptions) => {
 //   const params = getResourcesOptions(options);
 //   const { info } = await fetcher<{
 //     info: TafsirInfoResource;
@@ -2470,7 +2470,7 @@ var findAllRecitationStyles = /*#__PURE__*/function () {
 /**
  * Get all languages.
  * @description https://quran.api-docs.io/v4/resources/languages
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllLanguages()
  */
@@ -2508,7 +2508,7 @@ var findAllLanguages = /*#__PURE__*/function () {
 /**
  * Get all chapter infos.
  * @description https://quran.api-docs.io/v4/resources/chapter-info
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllChapterInfos()
  */
@@ -2546,7 +2546,7 @@ var findAllChapterInfos = /*#__PURE__*/function () {
 /**
  * Get verse media.
  * @description https://quran.api-docs.io/v4/resources/verse_media
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findVerseMedia()
  */
@@ -2584,7 +2584,7 @@ var findVerseMedia = /*#__PURE__*/function () {
 /**
  * Get all chapter reciters.
  * @description https://quran.api-docs.io/v4/resources/list-of-chapter-reciters
- * @param {GetResourcesOptions} options
+ * @param {GetResourceOptions} options
  * @example
  * quran.v4.resources.findAllChapterReciters()
  */
@@ -2653,13 +2653,13 @@ var getSearchOptions = function getSearchOptions(q, options) {
 /**
  * Search
  * @description https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj
- * @param q search query
- * @param options search options
+ * @param {string} q search query
+ * @param {SearchOptions} options
  * @example
- * quran.v4.search.search('الله')
- * quran.v4.search.search('الله', { language: Language.ENGLISH })
- * quran.v4.search.search('الله', { language: Language.ENGLISH, size: 10 })
- * quran.v4.search.search('الله', { language: Language.ENGLISH, page: 2 })
+ * quran.v4.search.search('نور')
+ * quran.v4.search.search('نور', { language: Language.ENGLISH })
+ * quran.v4.search.search('نور', { language: Language.ENGLISH, size: 10 })
+ * quran.v4.search.search('نور', { language: Language.ENGLISH, page: 2 })
  */