@elara-services/packages 7.0.0 → 7.0.1

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 (5) hide show
  1. package/dist/package.json +1 -1
  2. package/dist/src/lib/misc.d.ts +1 -1
  3. package/dist/src/lib/misc.js +5 -2
  4. package/docs/functions/fetch.html +4 -2
  5. package/package.json +1 -1
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elara-services/packages",
3
- "version": "7.0.0",
3
+ "version": "7.0.1",
4
4
  "description": "",
5
5
  "main": "./dist/src/index.js",
6
6
  "author": "SUPERCHIEFYT (Elara-Discord-Bots, Elara-Services)",
package/dist/src/lib/misc.d.ts CHANGED
@@ -14,7 +14,7 @@ type FetchOptions<B> = Partial<{
14
14
  }>;
15
15
  export declare function fetch<B extends object, T>(url: string, options?: FetchOptions<B>,
16
16
  /** The retries amount, this is automatically incremented (DO NOT TOUCH) */
17
- retries?: number): Promise<{
17
+ retries?: number, maxRetries?: number): Promise<{
18
18
  status: true;
19
19
  data: T;
20
20
  } | StatusFailed>;
package/dist/src/lib/misc.js CHANGED
@@ -14,9 +14,12 @@ const basic_utils_1 = require("@elara-services/basic-utils");
14
14
  const fetch_1 = require("@elara-services/fetch");
15
15
  function fetch(url, options = {},
16
16
  /** The retries amount, this is automatically incremented (DO NOT TOUCH) */
17
- retries = 0) {
17
+ retries = 0, maxRetries = 5) {
18
18
  var _a;
19
19
  return __awaiter(this, void 0, void 0, function* () {
20
+ if (retries >= maxRetries) {
21
+ return basic_utils_1.status.error(`Max (${maxRetries}) retries hit`);
22
+ }
20
23
  if (!basic_utils_1.is.object(options, true)) {
21
24
  options = {};
22
25
  }
@@ -40,7 +43,7 @@ retries = 0) {
40
43
  }
41
44
  if (res.statusCode === 429 && retries <= 5) {
42
45
  yield (0, basic_utils_1.sleep)(basic_utils_1.get.secs(5));
43
- return yield fetch(url, options, retries + 1);
46
+ return yield fetch(url, options, retries + 1, maxRetries);
44
47
  }
45
48
  if (res.statusCode !== 200) {
46
49
  return basic_utils_1.status.error(`Got (${res.statusCode}) status while trying to fetch the url.`);
package/docs/functions/fetch.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <h1>Function fetch</h1></div>
18
18
  <section class="tsd-panel">
19
19
  <ul class="tsd-signatures">
20
- <li class="tsd-signature tsd-anchor-link" id="fetch"><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">B</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">retries</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">StatusFailed</span><span class="tsd-signature-symbol">&gt;</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></li>
20
+ <li class="tsd-signature tsd-anchor-link" id="fetch"><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">B</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">retries</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">maxRetries</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">StatusFailed</span><span class="tsd-signature-symbol">&gt;</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></li>
21
21
  <li class="tsd-description">
22
22
  <section class="tsd-panel">
23
23
  <h4>Type Parameters</h4>
@@ -37,7 +37,9 @@
37
37
  <h5><span class="tsd-kind-parameter">retries</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5>
38
38
  <div class="tsd-comment tsd-typography"><p>The retries amount, this is automatically incremented (DO NOT TOUCH)</p>
39
39
  </div>
40
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
40
+ <div class="tsd-comment tsd-typography"></div></li>
41
+ <li>
42
+ <h5><span class="tsd-kind-parameter">maxRetries</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5</span></h5></li></ul></div>
41
43
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">StatusFailed</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
42
44
  <ul>
43
45
  <li>Defined in <a href="https://github.com/elara-bots/npm/blob/51e980b/packages-ts/src/lib/misc.ts#L17">lib/misc.ts:17</a></li></ul></aside></li></ul></section></div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elara-services/packages",
3
- "version": "7.0.0",
3
+ "version": "7.0.1",
4
4
  "description": "",
5
5
  "main": "./dist/src/index.js",
6
6
  "author": "SUPERCHIEFYT (Elara-Discord-Bots, Elara-Services)",