UseQueueReturnType

---

Import

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

Source

View the source code

Package

@hyper-fetch/react

Preview

type UseQueueReturnType<T> = {
  dispatcher: Dispatcher<ExtractAdapterType<T>>; 
  pause: () => void; 
  requests: QueueRequest<T>[]; 
  start: () => void; 
  stop: () => void; 
  stopped: boolean; 
}

Structure

UseQueueReturnType

Name	Type	Description
dispatcher	Dispatcher<ExtractAdapterType<T>>	Request dispatcher instance
requests	QueueRequest<T>[]	List of requests for provided request
stopped	boolean	Queue status for provided request
pause	() => void	Callback which allow to pause queue. It will allow ongoing requests to be finished, but will stop next from being send.
start	() => void	Callback which allow to start queue.
stop	() => void	Callback which allow to stop queue, it will cancel ongoing requests.