@hyper-fetch/react/src/hooks/use-queue/use-queue.types.ts

React hooks and utils for the hyper-fetch

import { ProgressType, RequestInstance, QueueItemType, Dispatcher, ExtractAdapterType } from "@hyper-fetch/core";

export type UseQueueOptionsType = {
  dispatcherType?: "auto" | "fetch" | "submit";
  keepFinishedRequests?: boolean;
};

export type QueueRequest<Request extends RequestInstance> = QueueItemType<Request> & {
  failed?: boolean;
  canceled?: boolean;
  removed?: boolean;
  success?: boolean;
  /**
   * Uploading progress for given request
   */
  uploading: ProgressType;
  /**
   * Downloading progress for given request
   */
  downloading: ProgressType;
  /**
   * Callback which allow to start previously stopped request.
   */
  startRequest: () => void;
  /**
   * Callback which allow to stop request and cancel it if it's ongoing.
   */
  stopRequest: () => void;
  /**
   * Removes request from the queue
   */
  deleteRequest: () => void;
};

export type UseQueueReturnType<T extends RequestInstance> = {
  /**
   * Queue status for provided request
   */
  stopped: boolean;
  /**
   * List of requests for provided request
   */
  requests: QueueRequest<T>[];
  /**
   * Request dispatcher instance
   */
  dispatcher: Dispatcher<ExtractAdapterType<T>>;
  /**
   * Callback which allow to stop queue, it will cancel ongoing requests.
   */
  stop: () => void;
  /**
   * Callback which allow to pause queue. It will allow ongoing requests to be finished, but will stop next from being send.
   */
  pause: () => void;
  /**
   * Callback which allow to start queue.
   */
  start: () => void;
};