Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListResponse<TItem>

Represents server response which is returned on list data request.

You can use this contract in your end-user code for better code completion.

Type parameters

  • TItem

Hierarchy

  • ListResponse

Index

Properties

items

items: TItem[]

Returned collection of records.

Optional loadedCount

loadedCount: number

Count of records that was loaded at last request.

Typically it's equal to items.length value. But it can differ for grouped lists, for example, so it's placed to a separate property.

Optional status

Optional value of type OperationStatus.

If value of this field is presented, response evaluated by List as intermediate.

This field can be used to perform data loading using async actions with tools like redux or ngrx.

Usually, start action returns response of this type with status field equal to OperationStatus.Progress

Later, when data loading is completed, regular {@link ListResponse} can be passed via same stream to complete loading operation.

totalCount

totalCount: number

Total count of records in remote data source. This property is used internally by pagers (e.g. to calculate total pages count in (PagedPager) and can be used to display total records count on UI.

Generated using TypeDoc