exFetch (Deno)

⚖️ MIT

	Heat	Release - Latest	Release - Pre
	|	()	()

A Deno module to extend fetch.

This project is inspired from:

• Deno - Standard Library - Async
• jhermsmeier/node-http-link-header
• node-fetch/node-fetch
• octokit/plugin-paginate-rest.js
• octokit/plugin-retry.js
• thlorenz/parse-link-header

🌟 Feature

• Cache suitable Request-Responses to reduce network usage and response time.
• Retry on failure requests, obey the response header Retry-After or a fallback random-able interval.
• Simplify paginate requests.

📥 Import

Deno

• Target Version: >= v1.35.0
• Require Permission:
  • allow-net (Allow Network Addresses): Resources Domain
• Domain/Registry:
  • Deno Land:

    https://deno.land/x/exfetch[@<Tag>]/mod.ts

  • DenoPKG:

    https://denopkg.com/hugoalh-studio/exfetch-deno[@<Tag>]/mod.ts

  • *GitHub Raw [Require Tag]:*

    https://raw.githubusercontent.com/hugoalh-studio/exfetch-deno/<Tag>/mod.ts

  • Pax:

    https://pax.deno.dev/hugoalh-studio/exfetch-deno[@<Tag>]/mod.ts

ℹ️ Notice: Although it is recommended to import main module with path mod.ts in general, it is also able to import part of the module with sub path if available, but do not import if:

• it’s file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
• it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
• it’s symbol has an underscore prefix (e.g.: export function _baz() {}).

These elements are not considered part of the public API, thus no stability is guaranteed for them.

🧩 API (Excerpt)

ℹ️ Notice: Documentation is included inside the script file, can view it via:

• Deno CLI deno doc
• Deno Doc Land

Class

• ExFetch

Function

• exFetch
• exFetchPaginate

Interface / Type

• ExFetchEventName
• ExFetchEventOnRetryParameters
• ExFetchEventOptions
• ExFetchIntervalOptions
• ExFetchOptions
• ExFetchPaginateOptions
• ExFetchRetryOptions

✍️ Example

• import { exFetchPaginate } from "https://raw.githubusercontent.com/hugoalh-studio/exfetch-deno/main/exfetch.ts";
  const responses: Response[] = await exFetchPaginate("https://api.github.com/repos/microsoft/vscode/labels?per_page=100");
  
  responses.map((response: Response) => {
    return response.ok;
  }).includes(false);
  //=> false (`false` when no broken page, otherwise `true`)
  
  const result = [];
  for (const response in responses) {
    result.push(...(await response.json()));
  }
  result;
  /*=>
  [
    {
      "id": 2339554941,
      "node_id": "MDU6TGFiZWwyMzM5NTU0OTQx",
      "url": "https://api.github.com/repos/microsoft/vscode/labels/:apple:%20si",
      "name": ":apple: si",
      "color": "e99695",
      "default": false,
      "description": "Issues related to apple silicon"
    },
    {
      "id": 421131022,
      "node_id": "MDU6TGFiZWw0MjExMzEwMjI=",
      "url": "https://api.github.com/repos/microsoft/vscode/labels/*as-designed",
      "name": "*as-designed",
      "color": "E2A1C2",
      "default": false,
      "description": "Described behavior is as designed"
    },
    {
      "id": 409283388,
      "node_id": "MDU6TGFiZWw0MDkyODMzODg=",
      "url": "https://api.github.com/repos/microsoft/vscode/labels/*caused-by-extension",
      "name": "*caused-by-extension",
      "color": "E2A1C2",
      "default": false,
      "description": "Issue identified to be caused by an extension"
    },
    {
      "id": 766755777,
      "node_id": "MDU6TGFiZWw3NjY3NTU3Nzc=",
      "url": "https://api.github.com/repos/microsoft/vscode/labels/*dev-question",
      "name": "*dev-question",
      "color": "E2A1C2",
      "default": false,
      "description": "VS Code Extension Development Question"
    },
    {
      "id": 366106217,
      "node_id": "MDU6TGFiZWwzNjYxMDYyMTc=",
      "url": "https://api.github.com/repos/microsoft/vscode/labels/*duplicate",
      "name": "*duplicate",
      "color": "E2A1C2",
      "default": false,
      "description": "Issue identified as a duplicate of another issue(s)"
    },
    ... +467
  ]
  */