ListData

Object

A plain JavaScript object used to hydrate a typed list. This is the data format resolved by getListData.

A ListData object should look like:

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

The object must have a data property that is an Array of instance data used to hydrate typed instances.

The ListData object can have other meta information related to the data that has been loaded. For example, count might be the total number of items the server has:

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

The can-connect/data/parse/parse behavior can be used to convert request responses to the ListData format.