Skip to main content
Version: v7.0.0

getInitialState


Import
import { getInitialState } from "@hyper-fetch/react"

Parameters

getInitialState<T>(__namedParameters: { disabled?: boolean; dispatcher: Dispatcher<ExtractAdapterType<T>>; initialResponse: NullableType<Partial<ExtractAdapterResolvedType<T>>>; request: T; revalidate?: boolean })
Parameters
NameTypeDescription
__namedParameters
{ disabled?: boolean; dispatcher: Dispatcher<ExtractAdapterType<T>>; initialResponse: NullableType<Partial<ExtractAdapterResolvedType<T>>>; request: T; revalidate?: boolean }

Returns

type UseTrackedStateType<T> = {
data: null | ExtractResponseType<T>;
error: null | ExtractErrorType<T>;
extra: null | ExtractAdapterExtraType<ExtractAdapterType<T>>;
loading: boolean;
requestTimestamp: null | Date;
responseTimestamp: null | Date;
retries: number;
status: null | ExtractAdapterStatusType<ExtractAdapterType<T>> | null;
success: boolean;
}
getInitialState
NameTypeDescription
data
null | ExtractResponseType<T>

Request response data

error
null | ExtractErrorType<T>

Request response error

extra
null | ExtractAdapterExtraType<ExtractAdapterType<T>>

Request additional response data

loading
boolean

Request loading state

requestTimestamp
null | Date

Request response timestamp

responseTimestamp
null | Date

Request response timestamp

retries
number

Request attempts

status
null | ExtractAdapterStatusType<ExtractAdapterType<T>> | null

Request status

success
boolean

Information whether request succeeded

React
On this page