Skip to content

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

NameTypeRequiredDescription
argsobjectyesThe arguments object.

args Properties

NameTypeRequiredDefaultDescription
clearObjectsFunctionCallback to clear existing objects when loading a new set.
isCancelledRefReactive flag indicating the request was cancelled.
paramsanyThe arguments for the list operation.
pushObjectsFunctionCallback to append fetched objects to the current list.
setColumnTotalsFunctionCallback to update column totals metadata.
setPaginateInfoFunctionCallback to update pagination metadata.
targetobjectThe 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:62

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2