Skip to main content

index/interfaces/ListResult.md

Generic list result type with pagination metadata

A reusable pattern for any paginated list response containing items and metadata. Reduces duplication across 95+ Result interfaces with similar structure. Uses cursor-based pagination (PageInfo).

Example​

// Define a specialized result type by extending ListResult
type BanListResult = ListResult<BanData>;
type TradeListResult = ListResult<TradeInfo>;

Since​

6.6.0

Updated​

8.0.0 - Migrated to cursor-based pagination with PageInfo

Type Parameters​

Type ParameterDescription
TThe type of items in the list

Properties​

PropertyTypeDescription
itemsT[]Array of items
pageInfoPageInfoPagination info (cursor-based)