Skip to main content
Version: 3.x.x

useFetch


import { useFetch } from "@hyper-fetch/react"

Description

Defined in react/src/hooks/use-fetch/use-fetch.hooks.ts:18

Preview

useFetch<RequestType>(request, options)

Parameters

NameDetails

request

Required

Request instance

RequestType

options

Required

Hook options

UseFetchOptionsType<RequestType>

Returns

{
additionalData: T extends BaseAdapterType<any, any, any, infer A, any> ? A : never;
data: null | T extends Request<infer D, any, any, any, any, any, any, any, any, any> ? D : never;
error: null | T extends Request<any, any, any, infer G, infer L, any, any, any, any, any> ? \G\ | \L\ : never;
isSuccess: boolean;
loading: boolean;
retries: number;
status: T extends BaseAdapterType<any, any, infer S, any, any> ? S : never;
timestamp: null | Date;
setAdditionalData: (additionalData: ExtractAdapterAdditionalDataType<ExtractAdapterType<T>>, emitToCache?: boolean) => void;
setData: (data: ExtractResponseType<T>, emitToCache?: boolean) => void;
setError: (error: ExtractErrorType<T>, emitToCache?: boolean) => void;
setIsSuccess: (isSuccess: boolean, emitToCache?: boolean) => void;
setLoading: (loading: boolean, emitToHooks?: boolean) => void;
setRetries: (retries: number, emitToCache?: boolean) => void;
setStatus: (status: ExtractAdapterStatusType<ExtractAdapterType<T>>, emitToCache?: boolean) => void;
setTimestamp: (timestamp: Date, emitToCache?: boolean) => void;
abort: () => void;
onAbort: (callback: OnErrorCallbackType<T>) => void;
onDownloadProgress: (callback: OnProgressCallbackType) => void;
onError: (callback: OnErrorCallbackType<T>) => void;
onFinished: (callback: OnFinishedCallbackType<T>) => void;
onOfflineError: (callback: OnErrorCallbackType<T>) => void;
onRequestStart: (callback: OnStartCallbackType<T>) => void;
onResponseStart: (callback: OnStartCallbackType<T>) => void;
onSuccess: (callback: OnSuccessCallbackType<T>) => void;
onUploadProgress: (callback: OnProgressCallbackType) => void;
bounce: {
active: boolean;
reset: () => void;
};
revalidate: (invalidateKey?: InvalidationKeyType | InvalidationKeyType[]) => void;
}