getListData

typedef

Retrieves list of records for the given set.

`function(set)`

Returns a promise that resolves to a ListData for a particular set.

connection.getListData({complete: true}).then(function(listData){
    connection.hydrateList(listData);
});

Parameters

set {Set}:
A object that represents the set of data needed to be loaded. For example, {complete: true} might represent the set of all completed records.

Returns

{Promise<ListData>}:

A promise that resolves to the ListData format like:

{
  data: [
    {id: 1, name: "take out the trash"},
    {id: 1, name: "do the dishes"}
  ],
  count: 1000
}

Use

Extensions like can-connect/data/url/url make it easy to implement getListData, but it can be as simple as:

var connection = connect([],{
  getListData: function(set){
    return new Promise(function(resolve, reject){
        $.get("/api/todos",set).then(resolve, reject)
    });
  }
})