UseRequestEventsActionsType

---

Import

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

Source

View the source code

Package

@hyper-fetch/react

Preview

type UseRequestEventsActionsType<T> = {
  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; 
}

Structure

UseRequestEventsActionsType

Name	Type	Description
abort	() => void	Callback that allows canceling ongoing requests from the given queryKey.
onAbort	(callback: OnErrorCallbackType<T>) => void	Helper hook listening on aborting of requests. Abort events are not triggering onError callbacks.
onDownloadProgress	(callback: OnProgressCallbackType) => void	Helper hook listening on download progress ETA. We can later match given requests by their id's or request instance which holds all data which is being transferred.
onError	(callback: OnErrorCallbackType<T>) => void	Helper hook listening on error response.
onFinished	(callback: OnFinishedCallbackType<T>) => void	Helper hook listening on any response.
onOfflineError	(callback: OnErrorCallbackType<T>) => void	Helper hook listening on request going into offline awaiting for network connection to be restored. It will not trigger onError when 'offline' mode is set on request.
onRequestStart	(callback: OnStartCallbackType<T>) => void	Helper hook listening on request start.
onResponseStart	(callback: OnStartCallbackType<T>) => void	Helper hook listening on response start(before we receive all data from server).
onSuccess	(callback: OnSuccessCallbackType<T>) => void	Helper hook listening on success response.
onUploadProgress	(callback: OnProgressCallbackType) => void	Helper hook listening on upload progress ETA. We can later match given requests by their id's or request instance which holds all data which is being transferred.