openmrs-esm-core

O3 Framework / UseServerFetchAllOptions

Interface: UseServerFetchAllOptions<R>

Defined in: packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:14

Extends

• UseServerInfiniteOptions<R>

Type Parameters

R

R

Properties

fetcher()?

optional fetcher: (key) => Promise<FetchResponse<R>>

Defined in: packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18

The fetcher to use. Defaults to openmrsFetch

Parameters

key

string

Returns

Promise<FetchResponse<R>>

Inherited from

UseServerInfiniteOptions.fetcher

---

immutable?

optional immutable: boolean

Defined in: packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25

If true, sets these options in swrInfintieConfig to false: revalidateIfStale, revalidateOnFocus, revalidateOnReconnect This should be the counterpart of using useSWRImmutable for useSWRInfinite`

Inherited from

UseServerInfiniteOptions.immutable

---

partialData?

optional partialData: boolean

Defined in: packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:21

If true, the data of any page is returned as soon as they are fetched. This is useful when you want to display data as soon as possible, even if not all pages are fetched. If false, the returned data will be undefined until all pages are fetched. This is useful when you want to display all data at once or reduce the number of re-renders (to avoid confusing users).

---

swrInfiniteConfig?

optional swrInfiniteConfig: SWRInfiniteConfiguration<any, any, BareFetcher<any>>

Defined in: packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27

Inherited from

UseServerInfiniteOptions.swrInfiniteConfig

This site is open source. Improve this page.