@toolbox-web/grid 2.13.0 → 2.14.0

package/lib/plugins/server-side/types.d.ts

@@ -1,5 +1,5 @@
 import { ServerSideDataSource } from './datasource-types';
-export type { DataRequestModel, DataSourceChildrenDetail, DataSourceDataDetail, DataSourceErrorDetail, DataSourceLoadingDetail, FetchChildrenQuery, GetChildRowsParams, GetChildRowsResult, GetRowsParams, GetRowsResult, ServerSideDataSource, Subscribable, ViewportMappingQuery, ViewportMappingResponse } from './datasource-types';
+export type { DataRequestModel, DataSourceChildrenDetail, DataSourceDataDetail, DataSourceErrorDetail, DataSourceLoadingDetail, FetchChildrenQuery, GetChildRowsParams, GetChildRowsResult, GetRowsParams, GetRowsResult, ServerSideDataSource, Subscribable, ViewportMappingQuery, ViewportMappingResponse, } from './datasource-types';
 /**
  * Configuration for the server-side data plugin.
  *
@@ -11,7 +11,6 @@ export type { DataRequestModel, DataSourceChildrenDetail, DataSourceDataDetail,
  * ```typescript
  * new ServerSidePlugin({
  *   pageSize: 100,
- *   cacheBlockSize: 200,
  *   maxConcurrentRequests: 2,
  * })
  * ```
@@ -19,17 +18,17 @@ export type { DataRequestModel, DataSourceChildrenDetail, DataSourceDataDetail,
  */
 export interface ServerSideConfig {
     /**
-     * Number of nodes to request per fetch.
-     * This determines the `endNode - startNode` range passed to `getRows()`.
-     * Smaller values mean faster initial loads but more frequent requests while scrolling.
+     * Number of nodes requested per `getRows()` call. The same value is surfaced
+     * on `params.pageSize` inside the callback, so backends that expect an
+     * explicit page-size query parameter can forward it directly. Larger values
+     * reduce request count at the cost of longer per-request latency.
      * @default 100
      */
     pageSize?: number;
     /**
-     * Number of nodes kept in each cache block.
-     * When a block is evicted (e.g. scrolled far away), re-scrolling back triggers a new fetch.
-     * Should be ≥ `pageSize`; larger values reduce re-fetches at the cost of memory.
-     * @default 200
+     * @deprecated Alias for {@link ServerSideConfig.pageSize}. Use `pageSize`
+     * instead. If both are set, `pageSize` wins. Will be removed in the next
+     * major release.
      */
     cacheBlockSize?: number;
     /**
@@ -53,7 +52,7 @@ export interface ServerSideConfig {
      * server with requests.
      *
      * A reasonable starting point is `pageSize / 2`. Values larger than
-     * `cacheBlockSize` will eagerly request 2+ blocks ahead, which can hurt
+     * `pageSize` will eagerly request 2+ blocks ahead, which can hurt
      * perceived performance with slow backends.
      *
      * @default 0 (fetch only when the visible window enters an unloaded block)