UseSubmitOptionsType

---

Import

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

Source

View the source code

Package

@hyper-fetch/react

Preview

type UseSubmitOptionsType<T,TSelected> = { bounce?: boolean; deepCompare?: (boolean | typeof isEqual); dependencyTracking?: boolean; disabled?: boolean; initialResponse?: NullableType<Partial<ExtractAdapterResolvedType<T>>>; select?: UseTrackedStateSelect<T, TSelected>; structuralSharing?: boolean } & ({ bounceTime?: number; bounceType?: debounce } | { bounceTime?: number; bounceTimeout?: number; bounceType: throttle });

Structure

UseSubmitOptionsType

Name	Type	Description
bounce	boolean	Enable/disable debouncing for often changing keys or refreshing, to limit requests to server.
deepCompare	boolean | typeof isEqual	Deep comparison function for hook to check for equality in incoming data, to limit rerenders.
dependencyTracking	boolean	If true it will rerender only when values used by our component gets changed. Otherwise it will rerender on any change.
disabled	boolean	Disable submitting
initialResponse	NullableType<Partial<ExtractAdapterResolvedType<T>>>	If cache is empty we can use placeholder data.
structuralSharing	boolean	Keep references of the unchanged parts of the selected data between updates (default true).
select	UseTrackedStateSelect<T, TSelected>	Pick or transform the part of the response data used by the component. Callbacks like onSubmitSuccess still receive the full response.