openmrs-esm-core

O3 Framework / useOpenmrsFetchAll

Function: useOpenmrsFetchAll()

useOpenmrsFetchAll<T>(url, options): UseServerInfiniteReturnObject<T, OpenMRSPaginatedResponse<T>>

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

Most OpenMRS REST endpoints that return a list of objects, such as getAll or search, are server-side paginated. This hook handles fetching results from all pages of a paginated OpenMRS REST endpoint, making multiple requests as needed.

Type Parameters

T

T

Parameters

url

The URL of the paginated OpenMRS REST endpoint. Note that the limit GET param can be set to specify the page size; if not set, the page size defaults to the webservices.rest.maxResultsDefault value defined server-side. Similar to useSWRInfinite, this param can be null to disable fetching.

string

URL

options

UseServerFetchAllOptions<OpenMRSPaginatedResponse<T>> = {}

The options object

Returns

UseServerInfiniteReturnObject<T, OpenMRSPaginatedResponse<T>>

a UseOpenmrsInfiniteReturnObject object

See

• useOpenmrsPagination
• useOpenmrsInfinite
• useFhirFetchAll

This site is open source. Improve this page.