The return value of fetchT includes an abort method.
The return data of fetchT is of a specific type, which can be either string, ArrayBuffer, Blob, or <T>(generic).
Support timeout.
Support progress.
# via pnpm
pnpm add @happy-ts/fetch-t
# or via yarn
yarn add @happy-ts/fetch-t
# or just from npm
npm install --save @happy-ts/fetch-t
# via JSR
jsr add @happy-ts/fetch-t
# for deno
deno add @happy-ts/fetch-t
# for bun
bunx jsr add @happy-ts/fetch-tfetchT is a simple encapsulation of the fetch API, with two main modifications:
- It adds the
abortableparameter. Ifabortable: trueis passed, fetchT will return aFetchTaskobject that allows you to abort the request by callingFetchTask.abort(). - It supports generic return values by adding the responseType parameter. The optional values for
responseTypeinclude'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.
import { fetchT } from '@happy-ts/fetch-t';
const fetchTask = fetchT('https://example.com', {
abortable: true,
responseType: 'json',
timeout: 3000,
onChunk(chunk): void {
console.assert(chunk instanceof Uint8Array);
},
onProgress(progressResult): void {
progressResult.inspect(progress => {
console.log(`${ progress.completedByteLength }/${ progress.totalByteLength }`);
}).inspectErr(err => {
console.error(err);
});
},
});
somethingHappenAsync(() => {
fetchTask.abort('cancel');
});
const res = await fetchTask.response;
res.inspect(data => {
console.log(data);
}).inspectErr(err => {
console.assert(err === 'cancel');
});For more examples, please refer to test case fetch.test.ts.