IDataProviderOptions Interface
The constructor options bag shared by all flat data providers. Every property is optional — pass only what you need to override the defaults.
Pass an options object to any flat data provider constructor.
import { CAPIFlatServerDataProvider } from '@katlux/providers'
const provider = new CAPIFlatServerDataProvider({
pageSize: 25,
currentPage: 1,
SSR: true,
cacheStrategy: 'Memory',
cacheLifetime: 60000, // 1 minute TTL
deduplicate: true,
urlPageParam: 'page', // syncs ?page= in browser URL
refreshOnMutation: true
})| Property | Type | Default | Description |
|---|
| filter | IDataFilter | null | null | Initial filter applied before the first fetch. |
| sortList | IDataSort[] | [] | Initial sort list applied before the first fetch. |
| pageSize | number | 10 | Number of records to request per page. |
| currentPage | number | 1 | Starting page index. |
| SSR | boolean | false | Enables Nuxt useAsyncData integration for SSR hydration and SEO. |
| cacheStrategy | ECacheStrategy | null | null | Cache backend to use for API responses via RequestProvider. |
| cacheLifetime | number | 0 | Time-to-live for cached responses in milliseconds. |
| deduplicate | boolean | true | Prevents duplicate concurrent requests with the same key. |
| urlPageParam | string | '' | When set, syncs currentPage with a browser URL query param (e.g. 'page' → ?page=2). |
| refreshOnMutation | boolean | true | Automatically re-fetches after a delete call. |
| filterDebounce | number | 0 | Debounce delay in milliseconds before re-filtering / reloading data. |
| sortDebounce | number | 0 | Debounce delay in milliseconds before re-sorting / reloading data. |