useSubmit

---

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

Description

Defined in hooks/use-submit/use-submit.hooks.ts:29

Preview

useSubmit<CommandType>(command, options)

Parameters

Name	Details
command Required	CommandType
options Required	UseSubmitOptionsType<CommandType>

Returns

{
  data: null | T extends Command<infer D, any, any, any, any, any, any, any, any, any, any> ? D : never;
  error: null | T extends Command<any, any, any, infer G, infer L, any, any, any, any, any, any> ? \G\ | \L\ : never;
  retries: number;
  status: null | number;
  timestamp: null | Date;
  setData: (data: ExtractResponse<T>, emitToCache?: boolean) => void;
  setError: (error: ExtractError<T>, emitToCache?: boolean) => void;
  setLoading: (loading: boolean, emitToHooks?: boolean) => void;
  setRetries: (retries: number, emitToCache?: boolean) => void;
  setStatus: (status: number | null, emitToCache?: boolean) => void;
  setTimestamp: (timestamp: Date, emitToCache?: boolean) => void;
  abort: () => void;
  bounce: {
    active: boolean;
    reset: () => void;
  };
  onSubmitAbort: (callback: OnErrorCallbackType<CommandType>) => void;
  onSubmitDownloadProgress: (callback: OnProgressCallbackType) => void;
  onSubmitError: (callback: OnErrorCallbackType<CommandType>) => void;
  onSubmitFinished: (callback: OnFinishedCallbackType<CommandType>) => void;
  onSubmitOfflineError: (callback: OnErrorCallbackType<CommandType>) => void;
  onSubmitRequestStart: (callback: OnStartCallbackType<CommandType>) => void;
  onSubmitResponseStart: (callback: OnStartCallbackType<CommandType>) => void;
  onSubmitSuccess: (callback: OnSuccessCallbackType<CommandType>) => void;
  onSubmitUploadProgress: (callback: OnProgressCallbackType) => void;
  revalidate: (invalidateKey: InvalidationKeyType | InvalidationKeyType[]) => void;
  submit: FetchType<Command>[data] extends NegativeTypes ? (FetchType<Command>[params] extends NegativeTypes ? (options?: FetchType<Command>) => Promise<ClientResponseType<ExtractResponse<Command>, ExtractError<Command>>> : (options: FetchType<Command>) => Promise<ClientResponseType<ExtractResponse<Command>, ExtractError<Command>>>) : (options: FetchType<Command>) => Promise<ClientResponseType<ExtractResponse<Command>, ExtractError<Command>>>;
  submitting: boolean;
}