Skip to content

allPagePaginatedListCrudAdaptor ​

Overview ​

The VUEDA specific implementation for reactive-helper's list crud function, for all pages.

Signature ​

allPagePaginatedListCrudAdaptor(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.
paramsobjectThe querystring parameters for the list operation.
pushObjectsFunctionCallback to append fetched objects to the current list.
repeatedParamsstring[]Params whose array elements are each sent as a repeated key; see makeSearchParamsString.
setColumnTotalsFunctionCallback to update column totals metadata.
setPaginateInfoFunctionCallback to update pagination metadata.
targetobjectVUEDA specific arguments for the CRUD operation. 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:150