useSubmit

---

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

Description

Defined in react/src/hooks/use-submit/use-submit.hooks.ts:30

Preview

useSubmit<RequestType>(request, options)

Parameters

Name	Details
request Required	RequestType
options Required	UseSubmitOptionsType<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;
  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;
  bounce: {
    active: boolean;
    reset: () => void;
  };
  onSubmitAbort: (callback: OnErrorCallbackType<RequestType>) => void;
  onSubmitDownloadProgress: (callback: OnProgressCallbackType) => void;
  onSubmitError: (callback: OnErrorCallbackType<RequestType>) => void;
  onSubmitFinished: (callback: OnFinishedCallbackType<RequestType>) => void;
  onSubmitOfflineError: (callback: OnErrorCallbackType<RequestType>) => void;
  onSubmitRequestStart: (callback: OnStartCallbackType<RequestType>) => void;
  onSubmitResponseStart: (callback: OnStartCallbackType<RequestType>) => void;
  onSubmitSuccess: (callback: OnSuccessCallbackType<RequestType>) => void;
  onSubmitUploadProgress: (callback: OnProgressCallbackType) => void;
  revalidate: (invalidateKey: InvalidationKeyType | InvalidationKeyType[]) => void;
  submit: RequestSendOptionsType<Request>[data] extends NegativeTypes ? (RequestSendOptionsType<Request>[params] extends NegativeTypes ? (options?: RequestSendOptionsType<Request>) => Promise<ResponseReturnType<ExtractResponseType<Request>, ExtractErrorType<Request>, ExtractAdapterType<Request>>> : (options: RequestSendOptionsType<Request>) => Promise<ResponseReturnType<ExtractResponseType<Request>, ExtractErrorType<Request>, ExtractAdapterType<Request>>>) : (options: RequestSendOptionsType<Request>) => Promise<ResponseReturnType<ExtractResponseType<Request>, ExtractErrorType<Request>, ExtractAdapterType<Request>>>;
  submitting: boolean;
}