useFetch

---

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

Description

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

Preview

useFetch<RequestType>(request, options)

Parameters

Name	Details
request Required	Request instance RequestType
options Required	Hook options UseFetchOptionsType<RequestType>

Returns

{
  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;
  extra: T extends AdapterType<any, any, any, infer A, any> ? A : never;
  loading: boolean;
  retries: number;
  status: T extends AdapterType<any, any, infer S, any, any> ? S : never;
  success: boolean;
  timestamp: null | Date;
  setData: (data: ExtractResponseType<T>, emitToCache?: boolean) => void;
  setError: (error: ExtractErrorType<T>, emitToCache?: boolean) => void;
  setExtra: (extra: ExtractAdapterExtraType<ExtractAdapterType<T>>, emitToCache?: boolean) => void;
  setLoading: (loading: boolean, emitToHooks?: boolean) => void;
  setRetries: (retries: number, emitToCache?: boolean) => void;
  setStatus: (status: ExtractAdapterStatusType<ExtractAdapterType<T>>, emitToCache?: boolean) => void;
  setSuccess: (success: boolean, 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;
  };
  refetch: (invalidateKey?: InvalidationKeyType | InvalidationKeyType[]) => void;
}