UNPKG

@happy-ts/fetch-t

Version:

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

424 lines (239 loc) 12.9 kB
[**@happy-ts/fetch-t**](../README.md) • **Docs** *** [@happy-ts/fetch-t](../README.md) / fetchT # Function: fetchT() Fetches a resource from the network and returns either a `FetchTask` or `FetchResponse` based on the provided options. ## Type Param The expected type of the response data when not using a specific `responseType`. ## Param 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. ## fetchT(url, init) ```ts function fetchT(url, init): FetchTask<string> ``` Fetches a resource from the network as a text string and returns a `FetchTask` representing the operation. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `abortable`: `true`; `responseType`: `"text"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. | ### Returns [`FetchTask`](../interfaces/FetchTask.md)\<`string`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchTask` representing the operation with a `string` response. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:14](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L14) ## fetchT(url, init) ```ts function fetchT(url, init): FetchTask<ArrayBuffer> ``` Fetches a resource from the network as an ArrayBuffer and returns a `FetchTask` representing the operation. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `abortable`: `true`; `responseType`: `"arraybuffer"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. | ### Returns [`FetchTask`](../interfaces/FetchTask.md)\<`ArrayBuffer`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchTask` representing the operation with an `ArrayBuffer` response. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:26](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L26) ## fetchT(url, init) ```ts function fetchT(url, init): FetchTask<Blob> ``` Fetches a resource from the network as a Blob and returns a `FetchTask` representing the operation. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `abortable`: `true`; `responseType`: `"blob"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. | ### Returns [`FetchTask`](../interfaces/FetchTask.md)\<`Blob`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchTask` representing the operation with a `Blob` response. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:38](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L38) ## fetchT(url, init) ```ts function fetchT<T>(url, init): FetchTask<T> ``` Fetches a resource from the network and parses it as JSON, returning a `FetchTask` representing the operation. ### Type Parameters | Type Parameter | Description | | ------ | ------ | | `T` | The expected type of the parsed JSON data. | ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `abortable`: `true`; `responseType`: `"json"`; \} | Additional options for the fetch operation, including custom `FetchInit` properties. | ### Returns [`FetchTask`](../interfaces/FetchTask.md)\<`T`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchTask` representing the operation with a response parsed as JSON. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:51](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L51) ## fetchT(url, init) ```ts function fetchT(url, init): FetchResponse<string, Error> ``` Fetches a resource from the network as a text string and returns a `FetchResponse` representing the operation. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `responseType`: `"text"`; \} | Additional options for the fetch operation, specifying the response type as 'text'. | ### Returns [`FetchResponse`](../type-aliases/FetchResponse.md)\<`string`, `Error`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchResponse` representing the operation with a `string` response. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:63](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L63) ## fetchT(url, init) ```ts function fetchT(url, init): FetchResponse<ArrayBuffer, Error> ``` Fetches a resource from the network as an ArrayBuffer and returns a `FetchResponse` representing the operation. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `responseType`: `"arraybuffer"`; \} | Additional options for the fetch operation, specifying the response type as 'arraybuffer'. | ### Returns [`FetchResponse`](../type-aliases/FetchResponse.md)\<`ArrayBuffer`, `Error`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchResponse` representing the operation with an `ArrayBuffer` response. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:74](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L74) ## fetchT(url, init) ```ts function fetchT(url, init): FetchResponse<Blob, Error> ``` Fetches a resource from the network as a Blob and returns a `FetchResponse` representing the operation. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `responseType`: `"blob"`; \} | Additional options for the fetch operation, specifying the response type as 'blob'. | ### Returns [`FetchResponse`](../type-aliases/FetchResponse.md)\<`Blob`, `Error`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchResponse` representing the operation with a `Blob` response. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:85](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L85) ## fetchT(url, init) ```ts function fetchT<T>(url, init): FetchResponse<T, Error> ``` Fetches a resource from the network and parses it as JSON, returning a `FetchResponse` representing the operation. ### Type Parameters | Type Parameter | Description | | ------ | ------ | | `T` | The expected type of the parsed JSON data. | ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `responseType`: `"json"`; \} | Additional options for the fetch operation, specifying the response type as 'json'. | ### Returns [`FetchResponse`](../type-aliases/FetchResponse.md)\<`T`, `Error`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchResponse` representing the operation with a response parsed as JSON. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:97](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L97) ## fetchT(url, init) ```ts function fetchT(url, init): FetchTask<Response> ``` Fetches a resource from the network and returns a `FetchTask` representing the operation with a generic `Response`. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init` | [`FetchInit`](../interfaces/FetchInit.md) & \{ `abortable`: `true`; \} | Additional options for the fetch operation, indicating that the operation should be abortable. | ### Returns [`FetchTask`](../interfaces/FetchTask.md)\<`Response`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchTask` representing the operation with a generic `Response`. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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:108](https://github.com/JiangJie/fetch-t/blob/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L108) ## fetchT(url, init) ```ts function fetchT(url, init?): FetchResponse<Response> ``` Fetches a resource from the network and returns a `FetchResponse` or `FetchTask` based on the provided options. ### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `url` | `string` \| `URL` | The resource to fetch. Can be a URL object or a string representing a URL. | | `init`? | [`FetchInit`](../interfaces/FetchInit.md) | Additional options for the fetch operation, including custom `FetchInit` properties. | ### Returns [`FetchResponse`](../type-aliases/FetchResponse.md)\<`Response`\> A `FetchTask` or `FetchResponse` depending on the provided options in `init`. A `FetchResponse` representing the operation with a `Response` object. ### Type Param The expected type of the response data when not using a specific `responseType`. ### Param 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/61346c95bab5342bcbd9e97bca747ef24af2eac6/src/fetch/fetch.ts#L120)