MENU
Redux Toolkit Query
Redux Toolkit 3,824 Query extends the functionality of Redux 3,824 to the back end by fetching data from the server and storing it into the state.
It caches the results so that an identical request in future will not trigger unnecessary fetching.
Overview: (usage to be explained in detail in the latter sections)
Root APIs- createApi({})
- fetchBaseQuery({})
- <ApiProvider>
- setupListeners()
- buildCreateApi
- coreModule
- reactHooksModule
- retry
Argument Keys to createApi({})
- baseQuery
- endpoints
- extractRehydrationInfo
- tagTypes
- reducerPath
- serializeQueryArgs
- keepUnusedDataFor
- refetchOnMountOrArgChange
- refetchOnFocus
- refetchOnReconnect
Member functions of createApi({}) endpoints builder
- query
- mutation
Argument Keys to createApi({}) endpoints builder
- query
- queryFn
- transformResponse
- extraOptions
- providesTags
- invalidatesTags
- keepUnusedDataFor
- onQueryStarted
- onCacheEntryAdded
Object keys of return slice of createApi({})
- reducerPath
- reducer
- middleware
- endpoints.{x}.initiate
- endpoints.{x}.select
- endpoints.{x}.matchPending
- endpoints.{x}.matchFulfilled
- endpoints.{x}.matchRejected
- injectEndpoints
- enhanceEndpoints
- utils.updateQueryData
- utils.patchQueryData
- utils.prefetch
- utils.invalidateTags
- utils.resetApiState
- utils.getRunningOperationPromises
- utils.getRunningOperationPromise
- internalActions
- [GeneratedReactHooks]
Generated React 7,897 Hooks in slice
- use[Lazy]Query[Subscription]
- useQueryState
- useMutation
- usePrefetch
Hook Options
- skip
- pollingInterval
- selectFromResult
- refetchOnMountOrArgChange
- refechOnFocus
- refetchOnReconnect
- fixedCacheKey
Keys to object returned from calling Generated React Hooks
- data
- currentData
- error
- isUnintialized
- isLoading
- isFetching
- isSuccess
- isError
- refetch
Argument keys to fetchBaseQuery({})
- baseUrl
- prepareHeaders
- paramsSerializer
- fetchFn
Arguments to setupListeners()
- dispatch
- customHandler(dispatch, { onFocus, onFocusLost, onOffline, onOnline })