singlePagePaginatedListCrudAdaptor
Overview
The VUEDA specific implementation for reactive-helper's list crud function, for a specific page. Supports fetching from a standard list or a custom detail action.
Signature
singlePagePaginatedListCrudAdaptor(args)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| args | object | yes | The arguments object. |
args Properties
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| clearObjects | Function | Callback to clear existing objects when loading a new set. | ||
| isCancelled | Ref | Reactive flag indicating the request was cancelled. | ||
| params | any | The arguments for the list operation. | ||
| pushObjects | Function | Callback to append fetched objects to the current list. | ||
| repeatedParams | string[] | Params whose array elements are each sent as a repeated key; see makeSearchParamsString. | ||
| setColumnTotals | Function | Callback to update column totals metadata. | ||
| setPaginateInfo | Function | Callback to update pagination metadata. | ||
| target | object | The arguments for the CRUD operation. If pk and action are provided, the detail action url will be used. Otherwise, the non-detail list url will be used. resultsKey is the response key holding the array of objects (defaults to "results"); it is supplied via the registered crud args (see setupDefaultListCrud). |
Returns
CancellablePromise
A cancellable promise.
Source
client/lib/utils/listCrud.js:84