2.5.4

Author: husayt

dist/index.cjs

@@ -1,5 +1,5 @@
 /*! 
- * Quran Meta library 2.5.3
+ * Quran Meta library 2.5.4
  *
  * Released under the MIT license
  */

dist/index.d.cts

@@ -46,8 +46,8 @@ type SuraName = [name: string, translitName: string];
 
 /**
  *  Turns String of type "x:y" or "x:y1-y2" to array [x,y] or [x,[y1,y2]] respectively
- * @param {*} str String of type "x:y" or "x:y1-y2"
- * @returns {array} array [x,y] or [x,[y1,y2]] respectively
+ * @param str - String of type "x:y" or "x:y1-y2"
+ * @returns array [x,y] or [x,[y1,y2]] respectively
  */
 declare function ayaStringSplitter(str: string): SurahAyahSegment;
 
@@ -132,15 +132,13 @@ declare function findJuzMetaBySurah(surah: Surah, ayah?: AyahNo): JuzMeta;
 declare function findPage(surah: Surah, ayah: AyahNo, ayahMode?: boolean): Page;
 
 /**
- * ALternative deprecated method
- * @param {*} pageNum
- */
-/**
- * Find range containing ayah according to the mode
- * @param surah
- * @param ayah
- * @param {*} mode can be either 'all', 'juz', 'surah', 'ayah', 'page'
- * default is all
+ * Finds a range of ayahs around a given ayah based on the specified mode.
+ *
+ * @param surah - The surah number (1-114)
+ * @param ayah - The ayah number within the surah, or the absolute ayah ID if ayahMode is true
+ * @param mode - The range mode: "juz", "surah", "ayah", "page", or "all"
+ * @param ayahMode - If true, treats the ayah parameter as an absolute ayah ID
+ * @returns A tuple containing the start and end ayah IDs of the range
  */
 declare function findRangeAroundAyah(surah: Surah, ayah: AyahNo, mode: "juz" | "surah" | "ayah" | "page" | "all", ayahMode?: boolean): SurahAyah;
 
@@ -211,11 +209,11 @@ declare const SuraList: SurahMeta[];
 declare function nextAyah(surah: Surah, ayah: AyahNo): SurahAyah;
 
 /**
- * Retrieves the page metadata for the specified page number.
+ * Retrieves metadata for a specific page of the Quran.
  *
- * @param pageNum - The page number to retrieve metadata for.
- * @returns The page metadata, including the first and last ayah IDs on the page.
- * @throws {RangeError} If the page number is out of the valid range (1 to `meta.numPages`).
+ * @param pageNum - The page number to retrieve metadata for (1-604)
+ * @returns An object containing the page number, first ayah, and last ayah on the page
+ * @throws RangeError If the page number is not between 1 and 604
  */
 declare function pageMeta(pageNum: Page): PageMeta;
 

dist/index.d.mts

@@ -46,8 +46,8 @@ type SuraName = [name: string, translitName: string];
 
 /**
  *  Turns String of type "x:y" or "x:y1-y2" to array [x,y] or [x,[y1,y2]] respectively
- * @param {*} str String of type "x:y" or "x:y1-y2"
- * @returns {array} array [x,y] or [x,[y1,y2]] respectively
+ * @param str - String of type "x:y" or "x:y1-y2"
+ * @returns array [x,y] or [x,[y1,y2]] respectively
  */
 declare function ayaStringSplitter(str: string): SurahAyahSegment;
 
@@ -132,15 +132,13 @@ declare function findJuzMetaBySurah(surah: Surah, ayah?: AyahNo): JuzMeta;
 declare function findPage(surah: Surah, ayah: AyahNo, ayahMode?: boolean): Page;
 
 /**
- * ALternative deprecated method
- * @param {*} pageNum
- */
-/**
- * Find range containing ayah according to the mode
- * @param surah
- * @param ayah
- * @param {*} mode can be either 'all', 'juz', 'surah', 'ayah', 'page'
- * default is all
+ * Finds a range of ayahs around a given ayah based on the specified mode.
+ *
+ * @param surah - The surah number (1-114)
+ * @param ayah - The ayah number within the surah, or the absolute ayah ID if ayahMode is true
+ * @param mode - The range mode: "juz", "surah", "ayah", "page", or "all"
+ * @param ayahMode - If true, treats the ayah parameter as an absolute ayah ID
+ * @returns A tuple containing the start and end ayah IDs of the range
  */
 declare function findRangeAroundAyah(surah: Surah, ayah: AyahNo, mode: "juz" | "surah" | "ayah" | "page" | "all", ayahMode?: boolean): SurahAyah;
 
@@ -211,11 +209,11 @@ declare const SuraList: SurahMeta[];
 declare function nextAyah(surah: Surah, ayah: AyahNo): SurahAyah;
 
 /**
- * Retrieves the page metadata for the specified page number.
+ * Retrieves metadata for a specific page of the Quran.
  *
- * @param pageNum - The page number to retrieve metadata for.
- * @returns The page metadata, including the first and last ayah IDs on the page.
- * @throws {RangeError} If the page number is out of the valid range (1 to `meta.numPages`).
+ * @param pageNum - The page number to retrieve metadata for (1-604)
+ * @returns An object containing the page number, first ayah, and last ayah on the page
+ * @throws RangeError If the page number is not between 1 and 604
  */
 declare function pageMeta(pageNum: Page): PageMeta;
 

dist/index.d.ts

@@ -46,8 +46,8 @@ type SuraName = [name: string, translitName: string];
 
 /**
  *  Turns String of type "x:y" or "x:y1-y2" to array [x,y] or [x,[y1,y2]] respectively
- * @param {*} str String of type "x:y" or "x:y1-y2"
- * @returns {array} array [x,y] or [x,[y1,y2]] respectively
+ * @param str - String of type "x:y" or "x:y1-y2"
+ * @returns array [x,y] or [x,[y1,y2]] respectively
  */
 declare function ayaStringSplitter(str: string): SurahAyahSegment;
 
@@ -132,15 +132,13 @@ declare function findJuzMetaBySurah(surah: Surah, ayah?: AyahNo): JuzMeta;
 declare function findPage(surah: Surah, ayah: AyahNo, ayahMode?: boolean): Page;
 
 /**
- * ALternative deprecated method
- * @param {*} pageNum
- */
-/**
- * Find range containing ayah according to the mode
- * @param surah
- * @param ayah
- * @param {*} mode can be either 'all', 'juz', 'surah', 'ayah', 'page'
- * default is all
+ * Finds a range of ayahs around a given ayah based on the specified mode.
+ *
+ * @param surah - The surah number (1-114)
+ * @param ayah - The ayah number within the surah, or the absolute ayah ID if ayahMode is true
+ * @param mode - The range mode: "juz", "surah", "ayah", "page", or "all"
+ * @param ayahMode - If true, treats the ayah parameter as an absolute ayah ID
+ * @returns A tuple containing the start and end ayah IDs of the range
  */
 declare function findRangeAroundAyah(surah: Surah, ayah: AyahNo, mode: "juz" | "surah" | "ayah" | "page" | "all", ayahMode?: boolean): SurahAyah;
 
@@ -211,11 +209,11 @@ declare const SuraList: SurahMeta[];
 declare function nextAyah(surah: Surah, ayah: AyahNo): SurahAyah;
 
 /**
- * Retrieves the page metadata for the specified page number.
+ * Retrieves metadata for a specific page of the Quran.
  *
- * @param pageNum - The page number to retrieve metadata for.
- * @returns The page metadata, including the first and last ayah IDs on the page.
- * @throws {RangeError} If the page number is out of the valid range (1 to `meta.numPages`).
+ * @param pageNum - The page number to retrieve metadata for (1-604)
+ * @returns An object containing the page number, first ayah, and last ayah on the page
+ * @throws RangeError If the page number is not between 1 and 604
  */
 declare function pageMeta(pageNum: Page): PageMeta;
 

dist/index.mjs

@@ -1,5 +1,5 @@
 /*! 
- * Quran Meta library 2.5.3
+ * Quran Meta library 2.5.4
  *
  * Released under the MIT license
  */

dist/quran-meta.js

@@ -1,5 +1,5 @@
 /*! 
- * Quran Meta library 2.5.3
+ * Quran Meta library 2.5.4
  *
  * Released under the MIT license
  */

dist/quran-meta.js.map

@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ayaStringSplitter | quran-meta</title><meta name="description" content="Documentation for quran-meta"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">quran-meta</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">quran-meta</a></li><li><a href="ayaStringSplitter.html">ayaStringSplitter</a></li></ul><h1>Function ayaStringSplitter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ayaStringSplitter" class="tsd-anchor"></a><span class="tsd-kind-call-signature">aya<wbr/>String<wbr/>Splitter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/SurahAyahSegment.html" class="tsd-signature-type tsd-kind-type-alias">SurahAyahSegment</a><a href="#ayaStringSplitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Turns String of type &quot;x:y&quot; or &quot;x:y1-y2&quot; to array [x,y] or [x,[y1,y2]] respectively</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ayaStringSplitter | quran-meta</title><meta name="description" content="Documentation for quran-meta"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/quran-center/quran-meta">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">quran-meta</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">quran-meta</a></li><li><a href="ayaStringSplitter.html">ayaStringSplitter</a></li></ul><h1>Function ayaStringSplitter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ayaStringSplitter" class="tsd-anchor"></a><span class="tsd-kind-call-signature">aya<wbr/>String<wbr/>Splitter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/SurahAyahSegment.html" class="tsd-signature-type tsd-kind-type-alias">SurahAyahSegment</a><a href="#ayaStringSplitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Turns String of type &quot;x:y&quot; or &quot;x:y1-y2&quot; to array [x,y] or [x,[y1,y2]] respectively</p>
 </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>String of type &quot;x:y&quot; or &quot;x:y1-y2&quot;</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/SurahAyahSegment.html" class="tsd-signature-type tsd-kind-type-alias">SurahAyahSegment</a></h4><p>array [x,y] or [x,[y1,y2]] respectively</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/quran-center/quran-meta/blob/39461bccdb89ac7fb292d34593aa2516860544ca/src/ayaStringSplitter.ts#L9">ayaStringSplitter.ts:9</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>quran-meta</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/quran-center/quran-meta/blob/8acd9769548269a9faf7b7a6c3124117ca46437c/src/ayaStringSplitter.ts#L9">ayaStringSplitter.ts:9</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://koran.center">Koran.center</a><a href="https://github.com/quran-center/quran-meta" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>quran-meta</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>