UseTrackedStateActions

---

Import

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

Source

View the source code

Package

@hyper-fetch/react

Preview

type UseTrackedStateActions<T,TData> = {
  clearState: () => void; 
  setData: (data: CacheSetState<TData | null>) => void; 
  setError: (error: CacheSetState<ExtractErrorType<T> | null>) => void; 
  setExtra: (extra: CacheSetState<ExtractAdapterExtraType<ExtractAdapterType<T>> | null>) => void; 
  setLoading: (loading: CacheSetState<boolean>) => void; 
  setRequestTimestamp: (timestamp: CacheSetState<Date>) => void; 
  setResponseTimestamp: (timestamp: CacheSetState<Date>) => void; 
  setRetries: (retries: CacheSetState<number>) => void; 
  setStatus: (status: CacheSetState<ExtractAdapterStatusType<ExtractAdapterType<T>>>) => void; 
  setSuccess: (success: CacheSetState<boolean>) => void; 
}

Structure

UseTrackedStateActions

Name	Type	Description
clearState	() => void	Reset all state fields to their initial values (data, error, status, extra → null, loading → false, etc.).
setData	(data: CacheSetState<TData | null>) => void	Action to set custom data. We can do it locally(inside hook state). When select is used it receives the selected data shape. If you need to update cache data use client.cache.update(). method.
setError	(error: CacheSetState<ExtractErrorType<T> | null>) => void	Action to set custom error. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.
setExtra	(extra: CacheSetState<ExtractAdapterExtraType<ExtractAdapterType<T>> | null>) => void	Action to set custom additional data. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.
setLoading	(loading: CacheSetState<boolean>) => void	Action to set custom loading. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.
setRequestTimestamp	(timestamp: CacheSetState<Date>) => void	Action to set custom timestamp. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.
setResponseTimestamp	(timestamp: CacheSetState<Date>) => void	Action to set custom timestamp. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.
setRetries	(retries: CacheSetState<number>) => void	Action to set custom retries count. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.
setStatus	(status: CacheSetState<ExtractAdapterStatusType<ExtractAdapterType<T>>>) => void	Action to set custom status. We can do it locally(inside hook state). If you need to turn on loading for all listening hooks use client.requestManager.events.emitLoading() method.
setSuccess	(success: CacheSetState<boolean>) => void	Action to set custom success. We can do it locally(inside hook state). If you need to update cache data use client.cache.update() method.