Type Alias UseReadResourceOptions<T>

type UseReadResourceOptions<T extends Entity> = {
    initialGetRequestHeaders?: Record<string, string>;
    initialState?: State<T>;
    refreshOnStale?: boolean;
}

Type Parameters

T extends Entity

Index

Properties

initialGetRequestHeaders? initialState? refreshOnStale?

Properties

`Optional`initialGetRequestHeaders

initialGetRequestHeaders?: Record<string, string>

HTTP headers to include if there was no existing cache, and the initial GET request must be done to get the state.

These headers are not used on subsequent refreshes/stale cases.

`Optional`initialState

initialState?: State<T>

`Optional`refreshOnStale

refreshOnStale?: boolean