@openmrs/esm-framework
Version:
67 lines (36 loc) • 1.61 kB
Markdown
[@openmrs/esm-framework](../API.md) / UseServerPaginationOptions
# Interface: UseServerPaginationOptions<R\>
## Type parameters
| Name |
| :------ |
| `R` |
## Table of contents
### UI Properties
- [immutable](UseServerPaginationOptions.md#immutable)
- [swrConfig](UseServerPaginationOptions.md#swrconfig)
### UI Methods
- [fetcher](UseServerPaginationOptions.md#fetcher)
## UI Properties
### immutable
• `Optional` **immutable**: `boolean`
Whether to use useSWR or useSWRInfinite to fetch data
#### Defined in
[packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L17)
___
### swrConfig
• `Optional` **swrConfig**: `SWRConfiguration`<`any`, `any`, `BareFetcher`<`any`\>\>
The configuration object for useSWR or useSWRInfinite
#### Defined in
[packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L27)
## UI Methods
### fetcher
▸ `Optional` **fetcher**(`key`): `Promise`<[`FetchResponse`](FetchResponse.md)<`R`\>\>
The fetcher to use. Defaults to openmrsFetch
#### Parameters
| Name | Type |
| :------ | :------ |
| `key` | `string` |
#### Returns
`Promise`<[`FetchResponse`](FetchResponse.md)<`R`\>\>
#### Defined in
[packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L22)