JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 847
  • Score
    100M100P100Q110530F
  • License GPL-3.0

Cancelable fetch wrapper with the ability to specify the return type.

Package Exports

  • @happy-ts/fetch-t

Readme

[中文]

fetchT

Installation

Via JSR (recommand)

npx jsr add @happy-ts/fetch-t

or just from npm

npm install --save @happy-ts/fetch-t

for deno

deno add @happy-ts/fetch-t

for bun

bunx jsr add @happy-ts/fetch-t

Why fetchT

fetchT is a simple encapsulation of the fetch API, with two main modifications:

  • It adds the abortable parameter. If abortable: true is passed, fetchT will return a FetchTask object that allows you to abort the request by calling FetchTask.abort().
  • It supports generic return values by adding the responseType parameter. The optional values for responseType include 'text' | 'arraybuffer' | 'blob' | 'json'. The return value corresponds to the parameter and can be either string | ArrayBuffer | Blob | T, where T is the generic type. All return values are of the Result type, which facilitates error handling.

If you don't have these requirements, it is recommended to use the vanilla fetch.

Examples

import { fetchT } from '@happy-ts/fetch-t';

const fetchTask = fetchT('https://example.com', {
    abortable: true,
    responseType: 'json',
});

somethingHappenAsync(() => {
    fetchTask.abort('cancel');
});

const res = await fetchTask.response;
if (res.isErr()) {
    console.assert(res.err() === 'cancel');
} else {
    console.log(res.unwrap());
}

For more examples, please refer to test case fetch.test.ts.