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. Ifabortable: true
is passed, fetchT will return aFetchTask
object that allows you to abort the request by callingFetchTask.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 eitherstring | 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.