@happy-ts/fetch-t 1.3.1 → 1.3.3

package/dist/main.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"main.cjs","sources":["../src/fetch/constants.ts","../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError' as const;\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError' as const;","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult, IOResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T> = AsyncResult<T, any>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    readonly aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    readonly response: FetchResponse<T>;\n}\n\n/**\n * Specifies the expected response type of the fetch request.\n */\nexport type FetchResponseType = 'text' | 'arraybuffer' | 'blob' | 'json';\n\n/**\n * Represents the progress of a fetch operation.\n */\nexport interface FetchProgress {\n    /**\n     * The total number of bytes to be received.\n     */\n    totalByteLength: number;\n\n    /**\n     * The number of bytes received so far.\n     */\n    completedByteLength: number;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: FetchResponseType;\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n\n    /**\n     * Specifies a function to be called when the fetch request makes progress.\n     * @param progressResult - The progress of the fetch request.\n     */\n    onProgress?: (progressResult: IOResult<FetchProgress>) => void;\n\n    /**\n     * Specifies a function to be called when the fetch request receives a chunk of data.\n     * @param chunk - The chunk of data received.\n     */\n    onChunk?: (chunk: Uint8Array) => void;\n}\n\n/**\n * Represents an error that occurred during a fetch operation when the response is not ok.\n */\nexport class FetchError extends Error {\n    /**\n     * The name of the error.\n     */\n    name = 'FetchError';\n    /**\n     * The status code of the response.\n     */\n    status = 0;\n\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}","import { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR } from './constants.ts';\nimport { FetchError, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: FetchInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        onProgress,\n        onChunk,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n    let cancelTimer: (() => void) | null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        cancelTimer?.();\n\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new FetchError(res.statusText, res.status));\n        }\n\n        if (res.body) {\n            // should notify progress or data chunk?\n            const shouldNotifyProgress = typeof onProgress === 'function';\n            const shouldNotifyChunk = typeof onChunk === 'function';\n\n            if ((shouldNotifyProgress || shouldNotifyChunk)) {\n                // tee the original stream to two streams, one for notify progress, another for response\n                const [stream1, stream2] = res.body.tee();\n\n                const reader = stream1.getReader();\n                // may has no  content-length\n                let totalByteLength: number | null = null;\n                let completedByteLength = 0;\n\n                if (shouldNotifyProgress) {\n                    // try to get content-length\n                    // compatible with http/2\n                    const contentLength = res.headers.get('content-length') ?? res.headers.get('Content-Length');\n                    if (contentLength == null) {\n                        // response headers has no content-length\n                        onProgress(Err(new Error('No content-length in response headers.')));\n                    } else {\n                        totalByteLength = parseInt(contentLength, 10);\n                    }\n                }\n\n                reader.read().then(function notify({ done, value }) {\n                    if (done) {\n                        return;\n                    }\n\n                    // notify chunk\n                    if (shouldNotifyChunk) {\n                        onChunk(value);\n                    }\n\n                    // notify progress\n                    if (shouldNotifyProgress && totalByteLength != null) {\n                        completedByteLength += value.byteLength;\n                        onProgress(Ok({\n                            totalByteLength,\n                            completedByteLength,\n                        }));\n                    }\n\n\n                    // continue to read\n                    reader.read().then(notify);\n                });\n\n                // replace the original response with the new one\n                res = new Response(stream2, {\n                    headers: res.headers,\n                    status: res.status,\n                    statusText: res.statusText,\n                });\n            }\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        cancelTimer?.();\n\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        const timer = setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n\n        cancelTimer = (): void => {\n            if (timer) {\n                clearTimeout(timer);\n            }\n\n            cancelTimer = null;\n        };\n    }\n\n    if (abortable) {\n        return {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            abort(reason?: any): void {\n                cancelTimer?.();\n                controller.abort(reason);\n            },\n\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n\n            get response(): FetchResponse<T> {\n                return response;\n            },\n        };\n    } else {\n        return response;\n    }\n}"],"names":["Err","Ok"],"mappings":";;;;;AAGO,MAAM,WAAc,GAAA,aAAA;AAKpB,MAAM,aAAgB,GAAA;;ACiFtB,MAAM,mBAAmB,KAAM,CAAA;AAAA;AAAA;AAAA;AAAA,EAIlC,IAAO,GAAA,YAAA,CAAA;AAAA;AAAA;AAAA;AAAA,EAIP,MAAS,GAAA,CAAA,CAAA;AAAA,EAET,WAAA,CAAY,SAAiB,MAAgB,EAAA;AACzC,IAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AACb,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAClB;AACJ;;AC0BgB,SAAA,MAAA,CAAU,KAAmB,IAAmD,EAAA;AAE5F,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAe,YAAA,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACnG;AAEA,EAAM,MAAA;AAAA;AAAA,IAEF,SAAY,GAAA,KAAA;AAAA,IACZ,YAAA;AAAA,IACA,OAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,GAAG,IAAA;AAAA,GACP,GAAI,QAAQ,EAAC,CAAA;AAEb,EAAA,MAAM,oBAAoB,OAAW,IAAA,IAAA,CAAA;AACrC,EAAI,IAAA,WAAA,CAAA;AAEJ,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAU,SAAA,CAAA,OAAO,YAAY,QAAY,IAAA,OAAA,GAAU,GAAG,MAAM,CAAA,qDAAA,EAAyD,OAAQ,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACpI;AAEA,EAAI,IAAA,UAAA,CAAA;AAEJ,EAAA,IAAI,aAAa,iBAAmB,EAAA;AAChC,IAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACjC,IAAA,IAAA,CAAK,SAAS,UAAW,CAAA,MAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,MAAM,WAA6B,KAAM,CAAA,GAAA,EAAK,IAAI,CAAE,CAAA,IAAA,CAAK,OAAO,GAA0B,KAAA;AACtF,IAAc,WAAA,IAAA,CAAA;AAEd,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACT,MAAM,MAAA,GAAA,CAAI,MAAM,MAAO,EAAA,CAAA;AACvB,MAAA,OAAOA,eAAI,IAAI,UAAA,CAAW,IAAI,UAAY,EAAA,GAAA,CAAI,MAAM,CAAC,CAAA,CAAA;AAAA,KACzD;AAEA,IAAA,IAAI,IAAI,IAAM,EAAA;AAEV,MAAM,MAAA,oBAAA,GAAuB,OAAO,UAAe,KAAA,UAAA,CAAA;AACnD,MAAM,MAAA,iBAAA,GAAoB,OAAO,OAAY,KAAA,UAAA,CAAA;AAE7C,MAAA,IAAK,wBAAwB,iBAAoB,EAAA;AAE7C,QAAA,MAAM,CAAC,OAAS,EAAA,OAAO,CAAI,GAAA,GAAA,CAAI,KAAK,GAAI,EAAA,CAAA;AAExC,QAAM,MAAA,MAAA,GAAS,QAAQ,SAAU,EAAA,CAAA;AAEjC,QAAA,IAAI,eAAiC,GAAA,IAAA,CAAA;AACrC,QAAA,IAAI,mBAAsB,GAAA,CAAA,CAAA;AAE1B,QAAA,IAAI,oBAAsB,EAAA;AAGtB,UAAM,MAAA,aAAA,GAAgB,IAAI,OAAQ,CAAA,GAAA,CAAI,gBAAgB,CAAK,IAAA,GAAA,CAAI,OAAQ,CAAA,GAAA,CAAI,gBAAgB,CAAA,CAAA;AAC3F,UAAA,IAAI,iBAAiB,IAAM,EAAA;AAEvB,YAAA,UAAA,CAAWA,cAAI,CAAA,IAAI,KAAM,CAAA,wCAAwC,CAAC,CAAC,CAAA,CAAA;AAAA,WAChE,MAAA;AACH,YAAkB,eAAA,GAAA,QAAA,CAAS,eAAe,EAAE,CAAA,CAAA;AAAA,WAChD;AAAA,SACJ;AAEA,QAAO,MAAA,CAAA,IAAA,GAAO,IAAK,CAAA,SAAS,OAAO,EAAE,IAAA,EAAM,OAAS,EAAA;AAChD,UAAA,IAAI,IAAM,EAAA;AACN,YAAA,OAAA;AAAA,WACJ;AAGA,UAAA,IAAI,iBAAmB,EAAA;AACnB,YAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,WACjB;AAGA,UAAI,IAAA,oBAAA,IAAwB,mBAAmB,IAAM,EAAA;AACjD,YAAA,mBAAA,IAAuB,KAAM,CAAA,UAAA,CAAA;AAC7B,YAAA,UAAA,CAAWC,aAAG,CAAA;AAAA,cACV,eAAA;AAAA,cACA,mBAAA;AAAA,aACH,CAAC,CAAA,CAAA;AAAA,WACN;AAIA,UAAO,MAAA,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAAA,SAC5B,CAAA,CAAA;AAGD,QAAM,GAAA,GAAA,IAAI,SAAS,OAAS,EAAA;AAAA,UACxB,SAAS,GAAI,CAAA,OAAA;AAAA,UACb,QAAQ,GAAI,CAAA,MAAA;AAAA,UACZ,YAAY,GAAI,CAAA,UAAA;AAAA,SACnB,CAAA,CAAA;AAAA,OACL;AAAA,KACJ;AAEA,IAAA,QAAQ,YAAc;AAAA,MAClB,KAAK,aAAe,EAAA;AAChB,QAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,WAAA,EAAkB,CAAA,CAAA;AAAA,OAC1C;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAI,IAAA;AACA,UAAA,OAAOA,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,SAC3B,CAAA,MAAA;AACJ,UAAA,OAAOD,cAAI,CAAA,IAAI,KAAM,CAAA,qDAAqD,CAAC,CAAA,CAAA;AAAA,SAC/E;AAAA,OACJ;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAOC,aAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAOA,cAAG,GAAQ,CAAA,CAAA;AAAA,OACtB;AAAA,KACJ;AAAA,GACH,CAAA,CAAE,KAAM,CAAA,CAAC,GAAQ,KAAA;AACd,IAAc,WAAA,IAAA,CAAA;AAEd,IAAA,OAAOD,eAAI,GAAG,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAM,MAAA,KAAA,GAAQ,WAAW,MAAM;AAC3B,MAAI,IAAA,CAAC,UAAW,CAAA,MAAA,CAAO,OAAS,EAAA;AAC5B,QAAM,MAAA,KAAA,GAAQ,IAAI,KAAM,EAAA,CAAA;AACxB,QAAA,KAAA,CAAM,IAAO,GAAA,aAAA,CAAA;AACb,QAAA,UAAA,CAAW,MAAM,KAAK,CAAA,CAAA;AAAA,OAC1B;AAAA,OACD,OAAO,CAAA,CAAA;AAEV,IAAA,WAAA,GAAc,MAAY;AACtB,MAAA,IAAI,KAAO,EAAA;AACP,QAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAAA,OACtB;AAEA,MAAc,WAAA,GAAA,IAAA,CAAA;AAAA,KAClB,CAAA;AAAA,GACJ;AAEA,EAAA,IAAI,SAAW,EAAA;AACX,IAAO,OAAA;AAAA;AAAA,MAEH,MAAM,MAAoB,EAAA;AACtB,QAAc,WAAA,IAAA,CAAA;AACd,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA,CAAA;AAAA,OAC3B;AAAA,MAEA,IAAI,OAAmB,GAAA;AACnB,QAAA,OAAO,WAAW,MAAO,CAAA,OAAA,CAAA;AAAA,OAC7B;AAAA,MAEA,IAAI,QAA6B,GAAA;AAC7B,QAAO,OAAA,QAAA,CAAA;AAAA,OACX;AAAA,KACJ,CAAA;AAAA,GACG,MAAA;AACH,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AACJ;;;;;;;"}
+{"version":3,"file":"main.cjs","sources":["../src/fetch/constants.ts","../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError' as const;\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError' as const;","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult, IOResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T, E = any> = AsyncResult<T, E>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    readonly aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    readonly response: FetchResponse<T>;\n}\n\n/**\n * Specifies the expected response type of the fetch request.\n */\nexport type FetchResponseType = 'text' | 'arraybuffer' | 'blob' | 'json';\n\n/**\n * Represents the progress of a fetch operation.\n */\nexport interface FetchProgress {\n    /**\n     * The total number of bytes to be received.\n     */\n    totalByteLength: number;\n\n    /**\n     * The number of bytes received so far.\n     */\n    completedByteLength: number;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: FetchResponseType;\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n\n    /**\n     * Specifies a function to be called when the fetch request makes progress.\n     * @param progressResult - The progress of the fetch request.\n     */\n    onProgress?: (progressResult: IOResult<FetchProgress>) => void;\n\n    /**\n     * Specifies a function to be called when the fetch request receives a chunk of data.\n     * @param chunk - The chunk of data received.\n     */\n    onChunk?: (chunk: Uint8Array) => void;\n}\n\n/**\n * Represents an error that occurred during a fetch operation when the response is not ok.\n */\nexport class FetchError extends Error {\n    /**\n     * The name of the error.\n     */\n    override name = 'FetchError';\n    /**\n     * The status code of the response.\n     */\n    status = 0;\n\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}","import { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR } from './constants.ts';\nimport { FetchError, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string, Error>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer, Error>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob, Error>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T, Error>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: FetchInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        onProgress,\n        onChunk,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n    let cancelTimer: (() => void) | null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        cancelTimer?.();\n\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new FetchError(res.statusText, res.status));\n        }\n\n        if (res.body) {\n            // should notify progress or data chunk?\n            const shouldNotifyProgress = typeof onProgress === 'function';\n            const shouldNotifyChunk = typeof onChunk === 'function';\n\n            if ((shouldNotifyProgress || shouldNotifyChunk)) {\n                // tee the original stream to two streams, one for notify progress, another for response\n                const [stream1, stream2] = res.body.tee();\n\n                const reader = stream1.getReader();\n                // may has no  content-length\n                let totalByteLength: number | null = null;\n                let completedByteLength = 0;\n\n                if (shouldNotifyProgress) {\n                    // try to get content-length\n                    // compatible with http/2\n                    const contentLength = res.headers.get('content-length') ?? res.headers.get('Content-Length');\n                    if (contentLength == null) {\n                        // response headers has no content-length\n                        onProgress(Err(new Error('No content-length in response headers.')));\n                    } else {\n                        totalByteLength = parseInt(contentLength, 10);\n                    }\n                }\n\n                reader.read().then(function notify({ done, value }) {\n                    if (done) {\n                        return;\n                    }\n\n                    // notify chunk\n                    if (shouldNotifyChunk) {\n                        onChunk(value);\n                    }\n\n                    // notify progress\n                    if (shouldNotifyProgress && totalByteLength != null) {\n                        completedByteLength += value.byteLength;\n                        onProgress(Ok({\n                            totalByteLength,\n                            completedByteLength,\n                        }));\n                    }\n\n\n                    // continue to read\n                    reader.read().then(notify);\n                });\n\n                // replace the original response with the new one\n                res = new Response(stream2, {\n                    headers: res.headers,\n                    status: res.status,\n                    statusText: res.statusText,\n                });\n            }\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        cancelTimer?.();\n\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        const timer = setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n\n        cancelTimer = (): void => {\n            if (timer) {\n                clearTimeout(timer);\n            }\n\n            cancelTimer = null;\n        };\n    }\n\n    if (abortable) {\n        return {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            abort(reason?: any): void {\n                cancelTimer?.();\n                controller.abort(reason);\n            },\n\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n\n            get response(): FetchResponse<T> {\n                return response;\n            },\n        };\n    } else {\n        return response;\n    }\n}"],"names":["Err","Ok"],"mappings":";;;;;AAGO,MAAM,WAAA,GAAc;AAKpB,MAAM,aAAA,GAAgB;;ACiFtB,MAAM,mBAAmB,KAAA,CAAM;AAAA;AAAA;AAAA;AAAA,EAIzB,IAAA,GAAO,YAAA;AAAA;AAAA;AAAA;AAAA,EAIhB,MAAA,GAAS,CAAA;AAAA,EAET,WAAA,CAAY,SAAiB,MAAA,EAAgB;AACzC,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAClB;AACJ;;AC0BO,SAAS,MAAA,CAAU,KAAmB,IAAA,EAAmD;AAE5F,EAAA,IAAI,OAAO,QAAQ,QAAA,EAAU;AACzB,IAAA,SAAA,CAAU,GAAA,YAAe,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAA,CAAA,CAAG,CAAA;AAAA,EACnG;AAEA,EAAA,MAAM;AAAA;AAAA,IAEF,SAAA,GAAY,KAAA;AAAA,IACZ,YAAA;AAAA,IACA,OAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,GAAG;AAAA,GACP,GAAI,QAAQ,EAAC;AAEb,EAAA,MAAM,oBAAoB,OAAA,IAAW,IAAA;AACrC,EAAA,IAAI,WAAA;AAEJ,EAAA,IAAI,iBAAA,EAAmB;AACnB,IAAA,SAAA,CAAU,OAAO,YAAY,QAAA,IAAY,OAAA,GAAU,GAAG,MAAM,CAAA,qDAAA,EAAyD,OAAQ,CAAA,CAAA,CAAG,CAAA;AAAA,EACpI;AAEA,EAAA,IAAI,UAAA;AAEJ,EAAA,IAAI,aAAa,iBAAA,EAAmB;AAChC,IAAA,UAAA,GAAa,IAAI,eAAA,EAAgB;AACjC,IAAA,IAAA,CAAK,SAAS,UAAA,CAAW,MAAA;AAAA,EAC7B;AAEA,EAAA,MAAM,WAA6B,KAAA,CAAM,GAAA,EAAK,IAAI,CAAA,CAAE,IAAA,CAAK,OAAO,GAAA,KAA0B;AACtF,IAAA,WAAA,IAAc;AAEd,IAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACT,MAAA,MAAM,GAAA,CAAI,MAAM,MAAA,EAAO;AACvB,MAAA,OAAOA,eAAI,IAAI,UAAA,CAAW,IAAI,UAAA,EAAY,GAAA,CAAI,MAAM,CAAC,CAAA;AAAA,IACzD;AAEA,IAAA,IAAI,IAAI,IAAA,EAAM;AAEV,MAAA,MAAM,oBAAA,GAAuB,OAAO,UAAA,KAAe,UAAA;AACnD,MAAA,MAAM,iBAAA,GAAoB,OAAO,OAAA,KAAY,UAAA;AAE7C,MAAA,IAAK,wBAAwB,iBAAA,EAAoB;AAE7C,QAAA,MAAM,CAAC,OAAA,EAAS,OAAO,CAAA,GAAI,GAAA,CAAI,KAAK,GAAA,EAAI;AAExC,QAAA,MAAM,MAAA,GAAS,QAAQ,SAAA,EAAU;AAEjC,QAAA,IAAI,eAAA,GAAiC,IAAA;AACrC,QAAA,IAAI,mBAAA,GAAsB,CAAA;AAE1B,QAAA,IAAI,oBAAA,EAAsB;AAGtB,UAAA,MAAM,aAAA,GAAgB,IAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA,IAAK,GAAA,CAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA;AAC3F,UAAA,IAAI,iBAAiB,IAAA,EAAM;AAEvB,YAAA,UAAA,CAAWA,cAAA,CAAI,IAAI,KAAA,CAAM,wCAAwC,CAAC,CAAC,CAAA;AAAA,UACvE,CAAA,MAAO;AACH,YAAA,eAAA,GAAkB,QAAA,CAAS,eAAe,EAAE,CAAA;AAAA,UAChD;AAAA,QACJ;AAEA,QAAA,MAAA,CAAO,IAAA,GAAO,IAAA,CAAK,SAAS,OAAO,EAAE,IAAA,EAAM,OAAM,EAAG;AAChD,UAAA,IAAI,IAAA,EAAM;AACN,YAAA;AAAA,UACJ;AAGA,UAAA,IAAI,iBAAA,EAAmB;AACnB,YAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,UACjB;AAGA,UAAA,IAAI,oBAAA,IAAwB,mBAAmB,IAAA,EAAM;AACjD,YAAA,mBAAA,IAAuB,KAAA,CAAM,UAAA;AAC7B,YAAA,UAAA,CAAWC,aAAA,CAAG;AAAA,cACV,eAAA;AAAA,cACA;AAAA,aACH,CAAC,CAAA;AAAA,UACN;AAIA,UAAA,MAAA,CAAO,IAAA,EAAK,CAAE,IAAA,CAAK,MAAM,CAAA;AAAA,QAC7B,CAAC,CAAA;AAGD,QAAA,GAAA,GAAM,IAAI,SAAS,OAAA,EAAS;AAAA,UACxB,SAAS,GAAA,CAAI,OAAA;AAAA,UACb,QAAQ,GAAA,CAAI,MAAA;AAAA,UACZ,YAAY,GAAA,CAAI;AAAA,SACnB,CAAA;AAAA,MACL;AAAA,IACJ;AAEA,IAAA,QAAQ,YAAA;AAAc,MAClB,KAAK,aAAA,EAAe;AAChB,QAAA,OAAOA,aAAA,CAAG,MAAM,GAAA,CAAI,WAAA,EAAkB,CAAA;AAAA,MAC1C;AAAA,MACA,KAAK,MAAA,EAAQ;AACT,QAAA,OAAOA,aAAA,CAAG,MAAM,GAAA,CAAI,IAAA,EAAW,CAAA;AAAA,MACnC;AAAA,MACA,KAAK,MAAA,EAAQ;AACT,QAAA,IAAI;AACA,UAAA,OAAOA,aAAA,CAAG,MAAM,GAAA,CAAI,IAAA,EAAW,CAAA;AAAA,QACnC,CAAA,CAAA,MAAQ;AACJ,UAAA,OAAOD,cAAA,CAAI,IAAI,KAAA,CAAM,qDAAqD,CAAC,CAAA;AAAA,QAC/E;AAAA,MACJ;AAAA,MACA,KAAK,MAAA,EAAQ;AACT,QAAA,OAAOC,aAAA,CAAG,MAAM,GAAA,CAAI,IAAA,EAAW,CAAA;AAAA,MACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAOA,cAAG,GAAQ,CAAA;AAAA,MACtB;AAAA;AACJ,EACJ,CAAC,CAAA,CAAE,KAAA,CAAM,CAAC,GAAA,KAAQ;AACd,IAAA,WAAA,IAAc;AAEd,IAAA,OAAOD,eAAI,GAAG,CAAA;AAAA,EAClB,CAAC,CAAA;AAED,EAAA,IAAI,iBAAA,EAAmB;AACnB,IAAA,MAAM,KAAA,GAAQ,WAAW,MAAM;AAC3B,MAAA,IAAI,CAAC,UAAA,CAAW,MAAA,CAAO,OAAA,EAAS;AAC5B,QAAA,MAAM,KAAA,GAAQ,IAAI,KAAA,EAAM;AACxB,QAAA,KAAA,CAAM,IAAA,GAAO,aAAA;AACb,QAAA,UAAA,CAAW,MAAM,KAAK,CAAA;AAAA,MAC1B;AAAA,IACJ,GAAG,OAAO,CAAA;AAEV,IAAA,WAAA,GAAc,MAAY;AACtB,MAAA,IAAI,KAAA,EAAO;AACP,QAAA,YAAA,CAAa,KAAK,CAAA;AAAA,MACtB;AAEA,MAAA,WAAA,GAAc,IAAA;AAAA,IAClB,CAAA;AAAA,EACJ;AAEA,EAAA,IAAI,SAAA,EAAW;AACX,IAAA,OAAO;AAAA;AAAA,MAEH,MAAM,MAAA,EAAoB;AACtB,QAAA,WAAA,IAAc;AACd,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA;AAAA,MAC3B,CAAA;AAAA,MAEA,IAAI,OAAA,GAAmB;AACnB,QAAA,OAAO,WAAW,MAAA,CAAO,OAAA;AAAA,MAC7B,CAAA;AAAA,MAEA,IAAI,QAAA,GAA6B;AAC7B,QAAA,OAAO,QAAA;AAAA,MACX;AAAA,KACJ;AAAA,EACJ,CAAA,MAAO;AACH,IAAA,OAAO,QAAA;AAAA,EACX;AACJ;;;;;;;"}

package/dist/main.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"main.mjs","sources":["../src/fetch/constants.ts","../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError' as const;\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError' as const;","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult, IOResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T> = AsyncResult<T, any>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    readonly aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    readonly response: FetchResponse<T>;\n}\n\n/**\n * Specifies the expected response type of the fetch request.\n */\nexport type FetchResponseType = 'text' | 'arraybuffer' | 'blob' | 'json';\n\n/**\n * Represents the progress of a fetch operation.\n */\nexport interface FetchProgress {\n    /**\n     * The total number of bytes to be received.\n     */\n    totalByteLength: number;\n\n    /**\n     * The number of bytes received so far.\n     */\n    completedByteLength: number;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: FetchResponseType;\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n\n    /**\n     * Specifies a function to be called when the fetch request makes progress.\n     * @param progressResult - The progress of the fetch request.\n     */\n    onProgress?: (progressResult: IOResult<FetchProgress>) => void;\n\n    /**\n     * Specifies a function to be called when the fetch request receives a chunk of data.\n     * @param chunk - The chunk of data received.\n     */\n    onChunk?: (chunk: Uint8Array) => void;\n}\n\n/**\n * Represents an error that occurred during a fetch operation when the response is not ok.\n */\nexport class FetchError extends Error {\n    /**\n     * The name of the error.\n     */\n    name = 'FetchError';\n    /**\n     * The status code of the response.\n     */\n    status = 0;\n\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}","import { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR } from './constants.ts';\nimport { FetchError, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: FetchInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        onProgress,\n        onChunk,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n    let cancelTimer: (() => void) | null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        cancelTimer?.();\n\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new FetchError(res.statusText, res.status));\n        }\n\n        if (res.body) {\n            // should notify progress or data chunk?\n            const shouldNotifyProgress = typeof onProgress === 'function';\n            const shouldNotifyChunk = typeof onChunk === 'function';\n\n            if ((shouldNotifyProgress || shouldNotifyChunk)) {\n                // tee the original stream to two streams, one for notify progress, another for response\n                const [stream1, stream2] = res.body.tee();\n\n                const reader = stream1.getReader();\n                // may has no  content-length\n                let totalByteLength: number | null = null;\n                let completedByteLength = 0;\n\n                if (shouldNotifyProgress) {\n                    // try to get content-length\n                    // compatible with http/2\n                    const contentLength = res.headers.get('content-length') ?? res.headers.get('Content-Length');\n                    if (contentLength == null) {\n                        // response headers has no content-length\n                        onProgress(Err(new Error('No content-length in response headers.')));\n                    } else {\n                        totalByteLength = parseInt(contentLength, 10);\n                    }\n                }\n\n                reader.read().then(function notify({ done, value }) {\n                    if (done) {\n                        return;\n                    }\n\n                    // notify chunk\n                    if (shouldNotifyChunk) {\n                        onChunk(value);\n                    }\n\n                    // notify progress\n                    if (shouldNotifyProgress && totalByteLength != null) {\n                        completedByteLength += value.byteLength;\n                        onProgress(Ok({\n                            totalByteLength,\n                            completedByteLength,\n                        }));\n                    }\n\n\n                    // continue to read\n                    reader.read().then(notify);\n                });\n\n                // replace the original response with the new one\n                res = new Response(stream2, {\n                    headers: res.headers,\n                    status: res.status,\n                    statusText: res.statusText,\n                });\n            }\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        cancelTimer?.();\n\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        const timer = setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n\n        cancelTimer = (): void => {\n            if (timer) {\n                clearTimeout(timer);\n            }\n\n            cancelTimer = null;\n        };\n    }\n\n    if (abortable) {\n        return {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            abort(reason?: any): void {\n                cancelTimer?.();\n                controller.abort(reason);\n            },\n\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n\n            get response(): FetchResponse<T> {\n                return response;\n            },\n        };\n    } else {\n        return response;\n    }\n}"],"names":[],"mappings":";;;AAGO,MAAM,WAAc,GAAA,aAAA;AAKpB,MAAM,aAAgB,GAAA;;ACiFtB,MAAM,mBAAmB,KAAM,CAAA;AAAA;AAAA;AAAA;AAAA,EAIlC,IAAO,GAAA,YAAA,CAAA;AAAA;AAAA;AAAA;AAAA,EAIP,MAAS,GAAA,CAAA,CAAA;AAAA,EAET,WAAA,CAAY,SAAiB,MAAgB,EAAA;AACzC,IAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AACb,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,GAClB;AACJ;;AC0BgB,SAAA,MAAA,CAAU,KAAmB,IAAmD,EAAA;AAE5F,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AACzB,IAAA,SAAA,CAAU,GAAe,YAAA,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACnG;AAEA,EAAM,MAAA;AAAA;AAAA,IAEF,SAAY,GAAA,KAAA;AAAA,IACZ,YAAA;AAAA,IACA,OAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,GAAG,IAAA;AAAA,GACP,GAAI,QAAQ,EAAC,CAAA;AAEb,EAAA,MAAM,oBAAoB,OAAW,IAAA,IAAA,CAAA;AACrC,EAAI,IAAA,WAAA,CAAA;AAEJ,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAU,SAAA,CAAA,OAAO,YAAY,QAAY,IAAA,OAAA,GAAU,GAAG,MAAM,CAAA,qDAAA,EAAyD,OAAQ,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,GACpI;AAEA,EAAI,IAAA,UAAA,CAAA;AAEJ,EAAA,IAAI,aAAa,iBAAmB,EAAA;AAChC,IAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACjC,IAAA,IAAA,CAAK,SAAS,UAAW,CAAA,MAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,MAAM,WAA6B,KAAM,CAAA,GAAA,EAAK,IAAI,CAAE,CAAA,IAAA,CAAK,OAAO,GAA0B,KAAA;AACtF,IAAc,WAAA,IAAA,CAAA;AAEd,IAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACT,MAAM,MAAA,GAAA,CAAI,MAAM,MAAO,EAAA,CAAA;AACvB,MAAA,OAAO,IAAI,IAAI,UAAA,CAAW,IAAI,UAAY,EAAA,GAAA,CAAI,MAAM,CAAC,CAAA,CAAA;AAAA,KACzD;AAEA,IAAA,IAAI,IAAI,IAAM,EAAA;AAEV,MAAM,MAAA,oBAAA,GAAuB,OAAO,UAAe,KAAA,UAAA,CAAA;AACnD,MAAM,MAAA,iBAAA,GAAoB,OAAO,OAAY,KAAA,UAAA,CAAA;AAE7C,MAAA,IAAK,wBAAwB,iBAAoB,EAAA;AAE7C,QAAA,MAAM,CAAC,OAAS,EAAA,OAAO,CAAI,GAAA,GAAA,CAAI,KAAK,GAAI,EAAA,CAAA;AAExC,QAAM,MAAA,MAAA,GAAS,QAAQ,SAAU,EAAA,CAAA;AAEjC,QAAA,IAAI,eAAiC,GAAA,IAAA,CAAA;AACrC,QAAA,IAAI,mBAAsB,GAAA,CAAA,CAAA;AAE1B,QAAA,IAAI,oBAAsB,EAAA;AAGtB,UAAM,MAAA,aAAA,GAAgB,IAAI,OAAQ,CAAA,GAAA,CAAI,gBAAgB,CAAK,IAAA,GAAA,CAAI,OAAQ,CAAA,GAAA,CAAI,gBAAgB,CAAA,CAAA;AAC3F,UAAA,IAAI,iBAAiB,IAAM,EAAA;AAEvB,YAAA,UAAA,CAAW,GAAI,CAAA,IAAI,KAAM,CAAA,wCAAwC,CAAC,CAAC,CAAA,CAAA;AAAA,WAChE,MAAA;AACH,YAAkB,eAAA,GAAA,QAAA,CAAS,eAAe,EAAE,CAAA,CAAA;AAAA,WAChD;AAAA,SACJ;AAEA,QAAO,MAAA,CAAA,IAAA,GAAO,IAAK,CAAA,SAAS,OAAO,EAAE,IAAA,EAAM,OAAS,EAAA;AAChD,UAAA,IAAI,IAAM,EAAA;AACN,YAAA,OAAA;AAAA,WACJ;AAGA,UAAA,IAAI,iBAAmB,EAAA;AACnB,YAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,WACjB;AAGA,UAAI,IAAA,oBAAA,IAAwB,mBAAmB,IAAM,EAAA;AACjD,YAAA,mBAAA,IAAuB,KAAM,CAAA,UAAA,CAAA;AAC7B,YAAA,UAAA,CAAW,EAAG,CAAA;AAAA,cACV,eAAA;AAAA,cACA,mBAAA;AAAA,aACH,CAAC,CAAA,CAAA;AAAA,WACN;AAIA,UAAO,MAAA,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAAA,SAC5B,CAAA,CAAA;AAGD,QAAM,GAAA,GAAA,IAAI,SAAS,OAAS,EAAA;AAAA,UACxB,SAAS,GAAI,CAAA,OAAA;AAAA,UACb,QAAQ,GAAI,CAAA,MAAA;AAAA,UACZ,YAAY,GAAI,CAAA,UAAA;AAAA,SACnB,CAAA,CAAA;AAAA,OACL;AAAA,KACJ;AAEA,IAAA,QAAQ,YAAc;AAAA,MAClB,KAAK,aAAe,EAAA;AAChB,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,WAAA,EAAkB,CAAA,CAAA;AAAA,OAC1C;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAI,IAAA;AACA,UAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,SAC3B,CAAA,MAAA;AACJ,UAAA,OAAO,GAAI,CAAA,IAAI,KAAM,CAAA,qDAAqD,CAAC,CAAA,CAAA;AAAA,SAC/E;AAAA,OACJ;AAAA,MACA,KAAK,MAAQ,EAAA;AACT,QAAA,OAAO,EAAG,CAAA,MAAM,GAAI,CAAA,IAAA,EAAW,CAAA,CAAA;AAAA,OACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAO,GAAG,GAAQ,CAAA,CAAA;AAAA,OACtB;AAAA,KACJ;AAAA,GACH,CAAA,CAAE,KAAM,CAAA,CAAC,GAAQ,KAAA;AACd,IAAc,WAAA,IAAA,CAAA;AAEd,IAAA,OAAO,IAAI,GAAG,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACnB,IAAM,MAAA,KAAA,GAAQ,WAAW,MAAM;AAC3B,MAAI,IAAA,CAAC,UAAW,CAAA,MAAA,CAAO,OAAS,EAAA;AAC5B,QAAM,MAAA,KAAA,GAAQ,IAAI,KAAM,EAAA,CAAA;AACxB,QAAA,KAAA,CAAM,IAAO,GAAA,aAAA,CAAA;AACb,QAAA,UAAA,CAAW,MAAM,KAAK,CAAA,CAAA;AAAA,OAC1B;AAAA,OACD,OAAO,CAAA,CAAA;AAEV,IAAA,WAAA,GAAc,MAAY;AACtB,MAAA,IAAI,KAAO,EAAA;AACP,QAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAAA,OACtB;AAEA,MAAc,WAAA,GAAA,IAAA,CAAA;AAAA,KAClB,CAAA;AAAA,GACJ;AAEA,EAAA,IAAI,SAAW,EAAA;AACX,IAAO,OAAA;AAAA;AAAA,MAEH,MAAM,MAAoB,EAAA;AACtB,QAAc,WAAA,IAAA,CAAA;AACd,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA,CAAA;AAAA,OAC3B;AAAA,MAEA,IAAI,OAAmB,GAAA;AACnB,QAAA,OAAO,WAAW,MAAO,CAAA,OAAA,CAAA;AAAA,OAC7B;AAAA,MAEA,IAAI,QAA6B,GAAA;AAC7B,QAAO,OAAA,QAAA,CAAA;AAAA,OACX;AAAA,KACJ,CAAA;AAAA,GACG,MAAA;AACH,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AACJ;;;;"}
+{"version":3,"file":"main.mjs","sources":["../src/fetch/constants.ts","../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError' as const;\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError' as const;","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult, IOResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T, E = any> = AsyncResult<T, E>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    readonly aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    readonly response: FetchResponse<T>;\n}\n\n/**\n * Specifies the expected response type of the fetch request.\n */\nexport type FetchResponseType = 'text' | 'arraybuffer' | 'blob' | 'json';\n\n/**\n * Represents the progress of a fetch operation.\n */\nexport interface FetchProgress {\n    /**\n     * The total number of bytes to be received.\n     */\n    totalByteLength: number;\n\n    /**\n     * The number of bytes received so far.\n     */\n    completedByteLength: number;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: FetchResponseType;\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n\n    /**\n     * Specifies a function to be called when the fetch request makes progress.\n     * @param progressResult - The progress of the fetch request.\n     */\n    onProgress?: (progressResult: IOResult<FetchProgress>) => void;\n\n    /**\n     * Specifies a function to be called when the fetch request receives a chunk of data.\n     * @param chunk - The chunk of data received.\n     */\n    onChunk?: (chunk: Uint8Array) => void;\n}\n\n/**\n * Represents an error that occurred during a fetch operation when the response is not ok.\n */\nexport class FetchError extends Error {\n    /**\n     * The name of the error.\n     */\n    override name = 'FetchError';\n    /**\n     * The status code of the response.\n     */\n    status = 0;\n\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}","import { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR } from './constants.ts';\nimport { FetchError, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string, Error>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer, Error>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob, Error>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T, Error>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: FetchInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        onProgress,\n        onChunk,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n    let cancelTimer: (() => void) | null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        cancelTimer?.();\n\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new FetchError(res.statusText, res.status));\n        }\n\n        if (res.body) {\n            // should notify progress or data chunk?\n            const shouldNotifyProgress = typeof onProgress === 'function';\n            const shouldNotifyChunk = typeof onChunk === 'function';\n\n            if ((shouldNotifyProgress || shouldNotifyChunk)) {\n                // tee the original stream to two streams, one for notify progress, another for response\n                const [stream1, stream2] = res.body.tee();\n\n                const reader = stream1.getReader();\n                // may has no  content-length\n                let totalByteLength: number | null = null;\n                let completedByteLength = 0;\n\n                if (shouldNotifyProgress) {\n                    // try to get content-length\n                    // compatible with http/2\n                    const contentLength = res.headers.get('content-length') ?? res.headers.get('Content-Length');\n                    if (contentLength == null) {\n                        // response headers has no content-length\n                        onProgress(Err(new Error('No content-length in response headers.')));\n                    } else {\n                        totalByteLength = parseInt(contentLength, 10);\n                    }\n                }\n\n                reader.read().then(function notify({ done, value }) {\n                    if (done) {\n                        return;\n                    }\n\n                    // notify chunk\n                    if (shouldNotifyChunk) {\n                        onChunk(value);\n                    }\n\n                    // notify progress\n                    if (shouldNotifyProgress && totalByteLength != null) {\n                        completedByteLength += value.byteLength;\n                        onProgress(Ok({\n                            totalByteLength,\n                            completedByteLength,\n                        }));\n                    }\n\n\n                    // continue to read\n                    reader.read().then(notify);\n                });\n\n                // replace the original response with the new one\n                res = new Response(stream2, {\n                    headers: res.headers,\n                    status: res.status,\n                    statusText: res.statusText,\n                });\n            }\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        cancelTimer?.();\n\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        const timer = setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n\n        cancelTimer = (): void => {\n            if (timer) {\n                clearTimeout(timer);\n            }\n\n            cancelTimer = null;\n        };\n    }\n\n    if (abortable) {\n        return {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            abort(reason?: any): void {\n                cancelTimer?.();\n                controller.abort(reason);\n            },\n\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n\n            get response(): FetchResponse<T> {\n                return response;\n            },\n        };\n    } else {\n        return response;\n    }\n}"],"names":[],"mappings":";;;AAGO,MAAM,WAAA,GAAc;AAKpB,MAAM,aAAA,GAAgB;;ACiFtB,MAAM,mBAAmB,KAAA,CAAM;AAAA;AAAA;AAAA;AAAA,EAIzB,IAAA,GAAO,YAAA;AAAA;AAAA;AAAA;AAAA,EAIhB,MAAA,GAAS,CAAA;AAAA,EAET,WAAA,CAAY,SAAiB,MAAA,EAAgB;AACzC,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AAAA,EAClB;AACJ;;AC0BO,SAAS,MAAA,CAAU,KAAmB,IAAA,EAAmD;AAE5F,EAAA,IAAI,OAAO,QAAQ,QAAA,EAAU;AACzB,IAAA,SAAA,CAAU,GAAA,YAAe,GAAA,EAAK,MAAM,CAAA,gDAAA,EAAoD,GAAI,CAAA,CAAA,CAAG,CAAA;AAAA,EACnG;AAEA,EAAA,MAAM;AAAA;AAAA,IAEF,SAAA,GAAY,KAAA;AAAA,IACZ,YAAA;AAAA,IACA,OAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,GAAG;AAAA,GACP,GAAI,QAAQ,EAAC;AAEb,EAAA,MAAM,oBAAoB,OAAA,IAAW,IAAA;AACrC,EAAA,IAAI,WAAA;AAEJ,EAAA,IAAI,iBAAA,EAAmB;AACnB,IAAA,SAAA,CAAU,OAAO,YAAY,QAAA,IAAY,OAAA,GAAU,GAAG,MAAM,CAAA,qDAAA,EAAyD,OAAQ,CAAA,CAAA,CAAG,CAAA;AAAA,EACpI;AAEA,EAAA,IAAI,UAAA;AAEJ,EAAA,IAAI,aAAa,iBAAA,EAAmB;AAChC,IAAA,UAAA,GAAa,IAAI,eAAA,EAAgB;AACjC,IAAA,IAAA,CAAK,SAAS,UAAA,CAAW,MAAA;AAAA,EAC7B;AAEA,EAAA,MAAM,WAA6B,KAAA,CAAM,GAAA,EAAK,IAAI,CAAA,CAAE,IAAA,CAAK,OAAO,GAAA,KAA0B;AACtF,IAAA,WAAA,IAAc;AAEd,IAAA,IAAI,CAAC,IAAI,EAAA,EAAI;AACT,MAAA,MAAM,GAAA,CAAI,MAAM,MAAA,EAAO;AACvB,MAAA,OAAO,IAAI,IAAI,UAAA,CAAW,IAAI,UAAA,EAAY,GAAA,CAAI,MAAM,CAAC,CAAA;AAAA,IACzD;AAEA,IAAA,IAAI,IAAI,IAAA,EAAM;AAEV,MAAA,MAAM,oBAAA,GAAuB,OAAO,UAAA,KAAe,UAAA;AACnD,MAAA,MAAM,iBAAA,GAAoB,OAAO,OAAA,KAAY,UAAA;AAE7C,MAAA,IAAK,wBAAwB,iBAAA,EAAoB;AAE7C,QAAA,MAAM,CAAC,OAAA,EAAS,OAAO,CAAA,GAAI,GAAA,CAAI,KAAK,GAAA,EAAI;AAExC,QAAA,MAAM,MAAA,GAAS,QAAQ,SAAA,EAAU;AAEjC,QAAA,IAAI,eAAA,GAAiC,IAAA;AACrC,QAAA,IAAI,mBAAA,GAAsB,CAAA;AAE1B,QAAA,IAAI,oBAAA,EAAsB;AAGtB,UAAA,MAAM,aAAA,GAAgB,IAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA,IAAK,GAAA,CAAI,OAAA,CAAQ,GAAA,CAAI,gBAAgB,CAAA;AAC3F,UAAA,IAAI,iBAAiB,IAAA,EAAM;AAEvB,YAAA,UAAA,CAAW,GAAA,CAAI,IAAI,KAAA,CAAM,wCAAwC,CAAC,CAAC,CAAA;AAAA,UACvE,CAAA,MAAO;AACH,YAAA,eAAA,GAAkB,QAAA,CAAS,eAAe,EAAE,CAAA;AAAA,UAChD;AAAA,QACJ;AAEA,QAAA,MAAA,CAAO,IAAA,GAAO,IAAA,CAAK,SAAS,OAAO,EAAE,IAAA,EAAM,OAAM,EAAG;AAChD,UAAA,IAAI,IAAA,EAAM;AACN,YAAA;AAAA,UACJ;AAGA,UAAA,IAAI,iBAAA,EAAmB;AACnB,YAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,UACjB;AAGA,UAAA,IAAI,oBAAA,IAAwB,mBAAmB,IAAA,EAAM;AACjD,YAAA,mBAAA,IAAuB,KAAA,CAAM,UAAA;AAC7B,YAAA,UAAA,CAAW,EAAA,CAAG;AAAA,cACV,eAAA;AAAA,cACA;AAAA,aACH,CAAC,CAAA;AAAA,UACN;AAIA,UAAA,MAAA,CAAO,IAAA,EAAK,CAAE,IAAA,CAAK,MAAM,CAAA;AAAA,QAC7B,CAAC,CAAA;AAGD,QAAA,GAAA,GAAM,IAAI,SAAS,OAAA,EAAS;AAAA,UACxB,SAAS,GAAA,CAAI,OAAA;AAAA,UACb,QAAQ,GAAA,CAAI,MAAA;AAAA,UACZ,YAAY,GAAA,CAAI;AAAA,SACnB,CAAA;AAAA,MACL;AAAA,IACJ;AAEA,IAAA,QAAQ,YAAA;AAAc,MAClB,KAAK,aAAA,EAAe;AAChB,QAAA,OAAO,EAAA,CAAG,MAAM,GAAA,CAAI,WAAA,EAAkB,CAAA;AAAA,MAC1C;AAAA,MACA,KAAK,MAAA,EAAQ;AACT,QAAA,OAAO,EAAA,CAAG,MAAM,GAAA,CAAI,IAAA,EAAW,CAAA;AAAA,MACnC;AAAA,MACA,KAAK,MAAA,EAAQ;AACT,QAAA,IAAI;AACA,UAAA,OAAO,EAAA,CAAG,MAAM,GAAA,CAAI,IAAA,EAAW,CAAA;AAAA,QACnC,CAAA,CAAA,MAAQ;AACJ,UAAA,OAAO,GAAA,CAAI,IAAI,KAAA,CAAM,qDAAqD,CAAC,CAAA;AAAA,QAC/E;AAAA,MACJ;AAAA,MACA,KAAK,MAAA,EAAQ;AACT,QAAA,OAAO,EAAA,CAAG,MAAM,GAAA,CAAI,IAAA,EAAW,CAAA;AAAA,MACnC;AAAA,MACA,SAAS;AAEL,QAAA,OAAO,GAAG,GAAQ,CAAA;AAAA,MACtB;AAAA;AACJ,EACJ,CAAC,CAAA,CAAE,KAAA,CAAM,CAAC,GAAA,KAAQ;AACd,IAAA,WAAA,IAAc;AAEd,IAAA,OAAO,IAAI,GAAG,CAAA;AAAA,EAClB,CAAC,CAAA;AAED,EAAA,IAAI,iBAAA,EAAmB;AACnB,IAAA,MAAM,KAAA,GAAQ,WAAW,MAAM;AAC3B,MAAA,IAAI,CAAC,UAAA,CAAW,MAAA,CAAO,OAAA,EAAS;AAC5B,QAAA,MAAM,KAAA,GAAQ,IAAI,KAAA,EAAM;AACxB,QAAA,KAAA,CAAM,IAAA,GAAO,aAAA;AACb,QAAA,UAAA,CAAW,MAAM,KAAK,CAAA;AAAA,MAC1B;AAAA,IACJ,GAAG,OAAO,CAAA;AAEV,IAAA,WAAA,GAAc,MAAY;AACtB,MAAA,IAAI,KAAA,EAAO;AACP,QAAA,YAAA,CAAa,KAAK,CAAA;AAAA,MACtB;AAEA,MAAA,WAAA,GAAc,IAAA;AAAA,IAClB,CAAA;AAAA,EACJ;AAEA,EAAA,IAAI,SAAA,EAAW;AACX,IAAA,OAAO;AAAA;AAAA,MAEH,MAAM,MAAA,EAAoB;AACtB,QAAA,WAAA,IAAc;AACd,QAAA,UAAA,CAAW,MAAM,MAAM,CAAA;AAAA,MAC3B,CAAA;AAAA,MAEA,IAAI,OAAA,GAAmB;AACnB,QAAA,OAAO,WAAW,MAAA,CAAO,OAAA;AAAA,MAC7B,CAAA;AAAA,MAEA,IAAI,QAAA,GAA6B;AAC7B,QAAA,OAAO,QAAA;AAAA,MACX;AAAA,KACJ;AAAA,EACJ,CAAA,MAAO;AACH,IAAA,OAAO,QAAA;AAAA,EACX;AACJ;;;;"}

package/dist/types.d.ts

@@ -14,7 +14,7 @@ declare const TIMEOUT_ERROR: "TimeoutError";
  *
  * @typeParam T - The type of the data expected in the response.
  */
-type FetchResponse<T> = AsyncResult<T, any>;
+type FetchResponse<T, E = any> = AsyncResult<T, E>;
 /**
  * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.
  *
@@ -150,7 +150,7 @@ declare function fetchT<T>(url: string | URL, init: FetchInit & {
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'text';
-}): FetchResponse<string>;
+}): FetchResponse<string, Error>;
 /**
  * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.
  *
@@ -160,7 +160,7 @@ declare function fetchT(url: string | URL, init: FetchInit & {
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'arraybuffer';
-}): FetchResponse<ArrayBuffer>;
+}): FetchResponse<ArrayBuffer, Error>;
 /**
  * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.
  *
@@ -170,7 +170,7 @@ declare function fetchT(url: string | URL, init: FetchInit & {
  */
 declare function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'blob';
-}): FetchResponse<Blob>;
+}): FetchResponse<Blob, Error>;
 /**
  * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.
  *
@@ -181,7 +181,7 @@ declare function fetchT(url: string | URL, init: FetchInit & {
  */
 declare function fetchT<T>(url: string | URL, init: FetchInit & {
     responseType: 'json';
-}): FetchResponse<T>;
+}): FetchResponse<T, Error>;
 /**
  * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.
  *
@@ -202,5 +202,6 @@ declare function fetchT(url: string | URL, init: FetchInit & {
  */
 declare function fetchT(url: string | URL, init?: FetchInit): FetchResponse<Response>;
 
-export { ABORT_ERROR, FetchError, type FetchInit, type FetchProgress, type FetchResponse, type FetchResponseType, type FetchTask, TIMEOUT_ERROR, fetchT };
+export { ABORT_ERROR, FetchError, TIMEOUT_ERROR, fetchT };
+export type { FetchInit, FetchProgress, FetchResponse, FetchResponseType, FetchTask };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"types.d.ts","sources":["../src/fetch/constants.ts","../src/fetch/defines.ts","../src/fetch/fetch.ts"],"sourcesContent":["/**\n * Name of abort error;\n */\nexport const ABORT_ERROR = 'AbortError' as const;\n\n/**\n * Name of timeout error;\n */\nexport const TIMEOUT_ERROR = 'TimeoutError' as const;","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { AsyncResult, IOResult } from 'happy-rusty';\n\n/**\n * Represents the response of a fetch operation, encapsulating the result data or any error that occurred.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport type FetchResponse<T, E = any> = AsyncResult<T, E>;\n\n/**\n * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.\n *\n * @typeParam T - The type of the data expected in the response.\n */\nexport interface FetchTask<T> {\n    /**\n     * Aborts the fetch task, optionally with a reason for the abortion.\n     *\n     * @param reason - An optional parameter to indicate why the task was aborted.\n     */\n    abort(reason?: any): void;\n\n    /**\n     * Indicates whether the fetch task has been aborted.\n     */\n    readonly aborted: boolean;\n\n    /**\n     * The response of the fetch task, represented as an `AsyncResult`.\n     */\n    readonly response: FetchResponse<T>;\n}\n\n/**\n * Specifies the expected response type of the fetch request.\n */\nexport type FetchResponseType = 'text' | 'arraybuffer' | 'blob' | 'json';\n\n/**\n * Represents the progress of a fetch operation.\n */\nexport interface FetchProgress {\n    /**\n     * The total number of bytes to be received.\n     */\n    totalByteLength: number;\n\n    /**\n     * The number of bytes received so far.\n     */\n    completedByteLength: number;\n}\n\n/**\n * Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.\n */\nexport interface FetchInit extends RequestInit {\n    /**\n     * Indicates whether the fetch request should be abortable.\n     */\n    abortable?: boolean;\n\n    /**\n     * Specifies the expected response type of the fetch request.\n     */\n    responseType?: FetchResponseType;\n\n    /**\n     * Specifies the maximum time in milliseconds to wait for the fetch request to complete.\n     */\n    timeout?: number;\n\n    /**\n     * Specifies a function to be called when the fetch request makes progress.\n     * @param progressResult - The progress of the fetch request.\n     */\n    onProgress?: (progressResult: IOResult<FetchProgress>) => void;\n\n    /**\n     * Specifies a function to be called when the fetch request receives a chunk of data.\n     * @param chunk - The chunk of data received.\n     */\n    onChunk?: (chunk: Uint8Array) => void;\n}\n\n/**\n * Represents an error that occurred during a fetch operation when the response is not ok.\n */\nexport class FetchError extends Error {\n    /**\n     * The name of the error.\n     */\n    override name = 'FetchError';\n    /**\n     * The status code of the response.\n     */\n    status = 0;\n\n    constructor(message: string, status: number) {\n        super(message);\n        this.status = status;\n    }\n}","import { Err, Ok } from 'happy-rusty';\nimport invariant from 'tiny-invariant';\nimport { TIMEOUT_ERROR } from './constants.ts';\nimport { FetchError, type FetchInit, type FetchResponse, type FetchTask } from './defines.ts';\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the response data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'text';\n}): FetchTask<string>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'arraybuffer';\n}): FetchTask<ArrayBuffer>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'blob';\n}): FetchTask<Blob>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    abortable: true;\n    responseType: 'json';\n}): FetchTask<T>;\n\n/**\n * Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'text'.\n * @returns A `FetchResponse` representing the operation with a `string` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'text';\n}): FetchResponse<string, Error>;\n\n/**\n * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'arraybuffer'.\n * @returns A `FetchResponse` representing the operation with an `ArrayBuffer` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'arraybuffer';\n}): FetchResponse<ArrayBuffer, Error>;\n\n/**\n * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'blob'.\n * @returns A `FetchResponse` representing the operation with a `Blob` response.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    responseType: 'blob';\n}): FetchResponse<Blob, Error>;\n\n/**\n * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.\n *\n * @typeParam T - The expected type of the parsed JSON data.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, specifying the response type as 'json'.\n * @returns A `FetchResponse` representing the operation with a response parsed as JSON.\n */\nexport function fetchT<T>(url: string | URL, init: FetchInit & {\n    responseType: 'json';\n}): FetchResponse<T, Error>;\n\n/**\n * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.\n *\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, indicating that the operation should be abortable.\n * @returns A `FetchTask` representing the operation with a generic `Response`.\n */\nexport function fetchT(url: string | URL, init: FetchInit & {\n    abortable: true;\n}): FetchTask<Response>;\n\n/**\n * Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchResponse` representing the operation with a `Response` object.\n */\nexport function fetchT(url: string | URL, init?: FetchInit): FetchResponse<Response>;\n\n/**\n * Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options.\n *\n * @typeParam T - The expected type of the response data when not using a specific `responseType`.\n * @param url - The resource to fetch. Can be a URL object or a string representing a URL.\n * @param init - Additional options for the fetch operation, including custom `FetchInit` properties.\n * @returns A `FetchTask` or `FetchResponse` depending on the provided options in `init`.\n */\nexport function fetchT<T>(url: string | URL, init?: FetchInit): FetchTask<T> | FetchResponse<T> {\n    // most cases\n    if (typeof url !== 'string') {\n        invariant(url instanceof URL, () => `Url must be a string or URL object but received ${ url }.`);\n    }\n\n    const {\n        // default not abort able\n        abortable = false,\n        responseType,\n        timeout,\n        onProgress,\n        onChunk,\n        ...rest\n    } = init ?? {};\n\n    const shouldWaitTimeout = timeout != null;\n    let cancelTimer: (() => void) | null;\n\n    if (shouldWaitTimeout) {\n        invariant(typeof timeout === 'number' && timeout > 0, () => `Timeout must be a number greater than 0 but received ${ timeout }.`);\n    }\n\n    let controller: AbortController;\n\n    if (abortable || shouldWaitTimeout) {\n        controller = new AbortController();\n        rest.signal = controller.signal;\n    }\n\n    const response: FetchResponse<T> = fetch(url, rest).then(async (res): FetchResponse<T> => {\n        cancelTimer?.();\n\n        if (!res.ok) {\n            await res.body?.cancel();\n            return Err(new FetchError(res.statusText, res.status));\n        }\n\n        if (res.body) {\n            // should notify progress or data chunk?\n            const shouldNotifyProgress = typeof onProgress === 'function';\n            const shouldNotifyChunk = typeof onChunk === 'function';\n\n            if ((shouldNotifyProgress || shouldNotifyChunk)) {\n                // tee the original stream to two streams, one for notify progress, another for response\n                const [stream1, stream2] = res.body.tee();\n\n                const reader = stream1.getReader();\n                // may has no  content-length\n                let totalByteLength: number | null = null;\n                let completedByteLength = 0;\n\n                if (shouldNotifyProgress) {\n                    // try to get content-length\n                    // compatible with http/2\n                    const contentLength = res.headers.get('content-length') ?? res.headers.get('Content-Length');\n                    if (contentLength == null) {\n                        // response headers has no content-length\n                        onProgress(Err(new Error('No content-length in response headers.')));\n                    } else {\n                        totalByteLength = parseInt(contentLength, 10);\n                    }\n                }\n\n                reader.read().then(function notify({ done, value }) {\n                    if (done) {\n                        return;\n                    }\n\n                    // notify chunk\n                    if (shouldNotifyChunk) {\n                        onChunk(value);\n                    }\n\n                    // notify progress\n                    if (shouldNotifyProgress && totalByteLength != null) {\n                        completedByteLength += value.byteLength;\n                        onProgress(Ok({\n                            totalByteLength,\n                            completedByteLength,\n                        }));\n                    }\n\n\n                    // continue to read\n                    reader.read().then(notify);\n                });\n\n                // replace the original response with the new one\n                res = new Response(stream2, {\n                    headers: res.headers,\n                    status: res.status,\n                    statusText: res.statusText,\n                });\n            }\n        }\n\n        switch (responseType) {\n            case 'arraybuffer': {\n                return Ok(await res.arrayBuffer() as T);\n            }\n            case 'blob': {\n                return Ok(await res.blob() as T);\n            }\n            case 'json': {\n                try {\n                    return Ok(await res.json() as T);\n                } catch {\n                    return Err(new Error('Response is invalid json while responseType is json'));\n                }\n            }\n            case 'text': {\n                return Ok(await res.text() as T);\n            }\n            default: {\n                // default return the Response object\n                return Ok(res as T);\n            }\n        }\n    }).catch((err) => {\n        cancelTimer?.();\n\n        return Err(err);\n    });\n\n    if (shouldWaitTimeout) {\n        const timer = setTimeout(() => {\n            if (!controller.signal.aborted) {\n                const error = new Error();\n                error.name = TIMEOUT_ERROR;\n                controller.abort(error);\n            }\n        }, timeout);\n\n        cancelTimer = (): void => {\n            if (timer) {\n                clearTimeout(timer);\n            }\n\n            cancelTimer = null;\n        };\n    }\n\n    if (abortable) {\n        return {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            abort(reason?: any): void {\n                cancelTimer?.();\n                controller.abort(reason);\n            },\n\n            get aborted(): boolean {\n                return controller.signal.aborted;\n            },\n\n            get response(): FetchResponse<T> {\n                return response;\n            },\n        };\n    } else {\n        return response;\n    }\n}"],"names":[],"mappings":";;AAAA;AACA;AACA;AACO,cAAA,WAAA;AACP;AACA;AACA;AACO,cAAA,aAAA;;ACNP;AACA;AACA;AACA;AACA;AACO,KAAA,aAAA,eAAA,WAAA;AACP;AACA;AACA;AACA;AACA;AACO,UAAA,SAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uBAAA,aAAA;AACA;AACA;AACA;AACA;AACO,KAAA,iBAAA;AACP;AACA;AACA;AACO,UAAA,aAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,UAAA,SAAA,SAAA,WAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA,mBAAA,iBAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kCAAA,QAAA,CAAA,aAAA;AACA;AACA;AACA;AACA;AACA,sBAAA,UAAA;AACA;AACA;AACA;AACA;AACO,cAAA,UAAA,SAAA,KAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;ACpFA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA,CAAA,WAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA,CAAA,IAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,kBAAA,GAAA,QAAA,SAAA;AACP;AACA;AACA,IAAA,SAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,SAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,CAAA,WAAA,EAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,CAAA,IAAA,EAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,kBAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,aAAA,IAAA,KAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,QAAA,SAAA;AACP;AACA,IAAA,SAAA,CAAA,QAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,MAAA,eAAA,GAAA,SAAA,SAAA,GAAA,aAAA,CAAA,QAAA;;;;"}

package/docs/README.md

@@ -1,4 +1,4 @@
-**@happy-ts/fetch-t** • **Docs**
+**@happy-ts/fetch-t**
 
 ***
 
@@ -36,4 +36,4 @@
 
 | Function | Description |
 | ------ | ------ |
-| [fetchT](functions/fetchT.md) | Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation. |
+| [fetchT](functions/fetchT.md) | Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options. |

package/docs/classes/FetchError.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Class: FetchError
 
+Defined in: [defines.ts:90](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L90)
+
 Represents an error that occurred during a fetch operation when the response is not ok.
 
 ## Extends
@@ -20,6 +22,8 @@ Represents an error that occurred during a fetch operation when the response is
 new FetchError(message, status): FetchError
 ```
 
+Defined in: [defines.ts:100](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L100)
+
 #### Parameters
 
 | Parameter | Type |
@@ -33,15 +37,13 @@ new FetchError(message, status): FetchError
 
 #### Overrides
 
-`Error.constructor`
-
-#### Defined in
-
-[defines.ts:100](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L100)
+```ts
+Error.constructor
+```
 
 ## Properties
 
 | Property | Type | Default value | Description | Overrides | Defined in |
 | ------ | ------ | ------ | ------ | ------ | ------ |
-| `name` | `string` | `'FetchError'` | The name of the error. | `Error.name` | [defines.ts:94](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L94) |
-| `status` | `number` | `0` | The status code of the response. | - | [defines.ts:98](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L98) |
+| <a id="name"></a> `name` | `string` | `'FetchError'` | The name of the error. | `Error.name` | [defines.ts:94](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L94) |
+| <a id="status-1"></a> `status` | `number` | `0` | The status code of the response. | - | [defines.ts:98](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L98) |

package/docs/functions/fetchT.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -20,12 +20,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-## fetchT(url, init)
+## Call Signature
 
 ```ts
 function fetchT(url, init): FetchTask<string>
 ```
 
+Defined in: [fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L14)
+
 Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation.
 
 ### Parameters
@@ -55,16 +57,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:14](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L14)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
 function fetchT(url, init): FetchTask<ArrayBuffer>
 ```
 
+Defined in: [fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L26)
+
 Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation.
 
 ### Parameters
@@ -94,16 +94,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:26](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L26)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
 function fetchT(url, init): FetchTask<Blob>
 ```
 
+Defined in: [fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L38)
+
 Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation.
 
 ### Parameters
@@ -133,16 +131,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:38](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L38)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
 function fetchT<T>(url, init): FetchTask<T>
 ```
 
+Defined in: [fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L51)
+
 Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation.
 
 ### Type Parameters
@@ -178,16 +174,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:51](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L51)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
-function fetchT(url, init): FetchResponse<string>
+function fetchT(url, init): FetchResponse<string, Error>
 ```
 
+Defined in: [fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L63)
+
 Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation.
 
 ### Parameters
@@ -199,7 +193,7 @@ Fetches a resource from the network as a text string and returns a `FetchRespons
 
 ### Returns
 
-[`FetchResponse`](../type-aliases/FetchResponse.md)\<`string`\>
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`string`, `Error`\>
 
 A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
 
@@ -217,16 +211,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:63](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L63)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
-function fetchT(url, init): FetchResponse<ArrayBuffer>
+function fetchT(url, init): FetchResponse<ArrayBuffer, Error>
 ```
 
+Defined in: [fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L74)
+
 Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.
 
 ### Parameters
@@ -238,7 +230,7 @@ Fetches a resource from the network as an ArrayBuffer and returns a `FetchRespon
 
 ### Returns
 
-[`FetchResponse`](../type-aliases/FetchResponse.md)\<`ArrayBuffer`\>
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`ArrayBuffer`, `Error`\>
 
 A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
 
@@ -256,16 +248,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:74](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L74)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
-function fetchT(url, init): FetchResponse<Blob>
+function fetchT(url, init): FetchResponse<Blob, Error>
 ```
 
+Defined in: [fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L85)
+
 Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.
 
 ### Parameters
@@ -277,7 +267,7 @@ Fetches a resource from the network as a Blob and returns a `FetchResponse` repr
 
 ### Returns
 
-[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Blob`\>
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`Blob`, `Error`\>
 
 A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
 
@@ -295,16 +285,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:85](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L85)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
-function fetchT<T>(url, init): FetchResponse<T>
+function fetchT<T>(url, init): FetchResponse<T, Error>
 ```
 
+Defined in: [fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L97)
+
 Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.
 
 ### Type Parameters
@@ -322,7 +310,7 @@ Fetches a resource from the network and parses it as JSON, returning a `FetchRes
 
 ### Returns
 
-[`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\>
+[`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`, `Error`\>
 
 A `FetchTask` or `FetchResponse` depending on the provided options in `init`.
 
@@ -340,16 +328,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:97](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L97)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
 function fetchT(url, init): FetchTask<Response>
 ```
 
+Defined in: [fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L108)
+
 Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.
 
 ### Parameters
@@ -379,16 +365,14 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
 
-### Defined in
-
-[fetch.ts:108](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L108)
-
-## fetchT(url, init)
+## Call Signature
 
 ```ts
 function fetchT(url, init?): FetchResponse<Response>
 ```
 
+Defined in: [fetch.ts:120](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/fetch.ts#L120)
+
 Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options.
 
 ### Parameters
@@ -417,7 +401,3 @@ The resource to fetch. Can be a URL object or a string representing a URL.
 ### Param
 
 Additional options for the fetch operation, including custom `FetchInit` properties.
-
-### Defined in
-
-[fetch.ts:120](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/fetch.ts#L120)

package/docs/interfaces/FetchInit.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Interface: FetchInit
 
+Defined in: [defines.ts:58](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L58)
+
 Extends the standard `RequestInit` interface from the Fetch API to include additional custom options.
 
 ## Extends
@@ -16,8 +18,8 @@ Extends the standard `RequestInit` interface from the Fetch API to include addit
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | [defines.ts:62](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L62) |
-| `onChunk?` | (`chunk`: `Uint8Array`) => `void` | Specifies a function to be called when the fetch request receives a chunk of data. | [defines.ts:84](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L84) |
-| `onProgress?` | (`progressResult`: `IOResult`\<[`FetchProgress`](FetchProgress.md)\>) => `void` | Specifies a function to be called when the fetch request makes progress. | [defines.ts:78](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L78) |
-| `responseType?` | [`FetchResponseType`](../type-aliases/FetchResponseType.md) | Specifies the expected response type of the fetch request. | [defines.ts:67](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L67) |
-| `timeout?` | `number` | Specifies the maximum time in milliseconds to wait for the fetch request to complete. | [defines.ts:72](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L72) |
+| <a id="abortable"></a> `abortable?` | `boolean` | Indicates whether the fetch request should be abortable. | [defines.ts:62](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L62) |
+| <a id="onchunk"></a> `onChunk?` | (`chunk`: `Uint8Array`) => `void` | Specifies a function to be called when the fetch request receives a chunk of data. | [defines.ts:84](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L84) |
+| <a id="onprogress"></a> `onProgress?` | (`progressResult`: `IOResult`\<[`FetchProgress`](FetchProgress.md)\>) => `void` | Specifies a function to be called when the fetch request makes progress. | [defines.ts:78](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L78) |
+| <a id="responsetype"></a> `responseType?` | [`FetchResponseType`](../type-aliases/FetchResponseType.md) | Specifies the expected response type of the fetch request. | [defines.ts:67](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L67) |
+| <a id="timeout"></a> `timeout?` | `number` | Specifies the maximum time in milliseconds to wait for the fetch request to complete. | [defines.ts:72](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L72) |

package/docs/interfaces/FetchProgress.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -6,11 +6,13 @@
 
 # Interface: FetchProgress
 
+Defined in: [defines.ts:43](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L43)
+
 Represents the progress of a fetch operation.
 
 ## Properties
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| `completedByteLength` | `number` | The number of bytes received so far. | [defines.ts:52](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L52) |
-| `totalByteLength` | `number` | The total number of bytes to be received. | [defines.ts:47](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L47) |
+| <a id="completedbytelength"></a> `completedByteLength` | `number` | The number of bytes received so far. | [defines.ts:52](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L52) |
+| <a id="totalbytelength"></a> `totalByteLength` | `number` | The total number of bytes to be received. | [defines.ts:47](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L47) |

package/docs/interfaces/FetchTask.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Interface: FetchTask\<T\>
 
+Defined in: [defines.ts:16](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L16)
+
 Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.
 
 ## Type Parameters
@@ -18,8 +20,8 @@ Defines the structure and behavior of a fetch task, including the ability to abo
 
 | Property | Modifier | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ | ------ |
-| `aborted` | `readonly` | `boolean` | Indicates whether the fetch task has been aborted. | [defines.ts:27](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L27) |
-| `response` | `readonly` | [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\> | The response of the fetch task, represented as an `AsyncResult`. | [defines.ts:32](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L32) |
+| <a id="aborted"></a> `aborted` | `readonly` | `boolean` | Indicates whether the fetch task has been aborted. | [defines.ts:27](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L27) |
+| <a id="response"></a> `response` | `readonly` | [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`\> | The response of the fetch task, represented as an `AsyncResult`. | [defines.ts:32](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L32) |
 
 ## Methods
 
@@ -29,6 +31,8 @@ Defines the structure and behavior of a fetch task, including the ability to abo
 abort(reason?): void
 ```
 
+Defined in: [defines.ts:22](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L22)
+
 Aborts the fetch task, optionally with a reason for the abortion.
 
 #### Parameters
@@ -40,7 +44,3 @@ Aborts the fetch task, optionally with a reason for the abortion.
 #### Returns
 
 `void`
-
-#### Defined in
-
-[defines.ts:22](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L22)

package/docs/type-aliases/FetchResponse.md

@@ -1,23 +1,22 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
 [@happy-ts/fetch-t](../README.md) / FetchResponse
 
-# Type Alias: FetchResponse\<T\>
+# Type Alias: FetchResponse\<T, E\>
 
 ```ts
-type FetchResponse<T>: AsyncResult<T, any>;
+type FetchResponse<T, E> = AsyncResult<T, E>;
 ```
 
+Defined in: [defines.ts:9](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L9)
+
 Represents the response of a fetch operation, encapsulating the result data or any error that occurred.
 
 ## Type Parameters
 
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the data expected in the response. |
-
-## Defined in
-
-[defines.ts:9](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L9)
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `T` | - | The type of the data expected in the response. |
+| `E` | `any` | - |

package/docs/type-aliases/FetchResponseType.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -7,11 +7,9 @@
 # Type Alias: FetchResponseType
 
 ```ts
-type FetchResponseType: "text" | "arraybuffer" | "blob" | "json";
+type FetchResponseType = "text" | "arraybuffer" | "blob" | "json";
 ```
 
-Specifies the expected response type of the fetch request.
-
-## Defined in
+Defined in: [defines.ts:38](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/defines.ts#L38)
 
-[defines.ts:38](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/defines.ts#L38)
+Specifies the expected response type of the fetch request.

package/docs/variables/ABORT_ERROR.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -10,8 +10,6 @@
 const ABORT_ERROR: "AbortError";
 ```
 
-Name of abort error;
-
-## Defined in
+Defined in: [constants.ts:4](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/constants.ts#L4)
 
-[constants.ts:4](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/constants.ts#L4)
+Name of abort error;

package/docs/variables/TIMEOUT_ERROR.md

@@ -1,4 +1,4 @@
-[**@happy-ts/fetch-t**](../README.md) • **Docs**
+[**@happy-ts/fetch-t**](../README.md)
 
 ***
 
@@ -10,8 +10,6 @@
 const TIMEOUT_ERROR: "TimeoutError";
 ```
 
-Name of timeout error;
-
-## Defined in
+Defined in: [constants.ts:9](https://github.com/JiangJie/fetch-t/blob/bef789cb418392a07597af77b2942bea27482d3e/src/fetch/constants.ts#L9)
 
-[constants.ts:9](https://github.com/JiangJie/fetch-t/blob/2e206031a806329279bb68d7ae74aa44f812eb58/src/fetch/constants.ts#L9)
+Name of timeout error;

package/package.json

@@ -3,7 +3,7 @@
   "description": "Abortable fetch wrapper with the ability to specify the return type.",
   "author": "jiang115jie@gmail.com",
   "license": "GPL-3.0",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "type": "module",
   "source": "src/mod.ts",
   "main": "dist/main.cjs",
@@ -43,20 +43,18 @@
     "responseType"
   ],
   "devDependencies": {
-    "@eslint/js": "^9.9.0",
-    "@types/eslint__js": "^8.42.3",
-    "eslint": "^9.9.0",
-    "rollup": "^4.20.0",
-    "rollup-plugin-dts": "^6.1.1",
-    "rollup-plugin-esbuild": "^6.1.1",
-    "typedoc": "^0.26.5",
-    "typedoc-plugin-markdown": "^4.2.3",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.0.1"
+    "@eslint/js": "^9.39.1",
+    "eslint": "^9.39.1",
+    "rollup": "^4.53.3",
+    "rollup-plugin-dts": "^6.3.0",
+    "rollup-plugin-esbuild": "^6.2.1",
+    "typedoc": "^0.27.9",
+    "typedoc-plugin-markdown": "^4.4.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.48.0"
   },
   "dependencies": {
     "happy-rusty": "^1.5.0",
     "tiny-invariant": "^1.3.3"
-  },
-  "packageManager": "pnpm@9.7.0"
+  }
 }

package/src/fetch/defines.ts

@@ -6,7 +6,7 @@ import type { AsyncResult, IOResult } from 'happy-rusty';
  *
  * @typeParam T - The type of the data expected in the response.
  */
-export type FetchResponse<T> = AsyncResult<T, any>;
+export type FetchResponse<T, E = any> = AsyncResult<T, E>;
 
 /**
  * Defines the structure and behavior of a fetch task, including the ability to abort the task and check its status.
@@ -91,7 +91,7 @@ export class FetchError extends Error {
     /**
      * The name of the error.
      */
-    name = 'FetchError';
+    override name = 'FetchError';
     /**
      * The status code of the response.
      */

package/src/fetch/fetch.ts

@@ -62,7 +62,7 @@ export function fetchT<T>(url: string | URL, init: FetchInit & {
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'text';
-}): FetchResponse<string>;
+}): FetchResponse<string, Error>;
 
 /**
  * Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation.
@@ -73,7 +73,7 @@ export function fetchT(url: string | URL, init: FetchInit & {
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'arraybuffer';
-}): FetchResponse<ArrayBuffer>;
+}): FetchResponse<ArrayBuffer, Error>;
 
 /**
  * Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation.
@@ -84,7 +84,7 @@ export function fetchT(url: string | URL, init: FetchInit & {
  */
 export function fetchT(url: string | URL, init: FetchInit & {
     responseType: 'blob';
-}): FetchResponse<Blob>;
+}): FetchResponse<Blob, Error>;
 
 /**
  * Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation.
@@ -96,7 +96,7 @@ export function fetchT(url: string | URL, init: FetchInit & {
  */
 export function fetchT<T>(url: string | URL, init: FetchInit & {
     responseType: 'json';
-}): FetchResponse<T>;
+}): FetchResponse<T, Error>;
 
 /**
  * Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`.