Skip to main content
Version: Next

PaginatedList <Data>

Paginated list with detailed pagination information.

Used primarily for Dataset items and other list operations that support offset-based pagination and field transformations.

Hierarchy

  • PaginatedResponse<Data>
    • PaginatedList

Index

Properties

Properties

count

count: number

Number of entries on this page. On a page from DatasetClient.listItems, the number of dataset rows the API scanned for it, or the number of items returned when that is larger. Filters (clean, skipEmpty) can leave it above items.length. The next page starts at offset + Math.min(count, limit); the cap matters only with unwind, which can return more items than the rows scanned.

desc

desc: boolean

Should the results be in descending order.

inheriteditems

items: Data[]

Entries.

limit

limit: number

Maximum number of dataset entries requested.

offset

offset: number

Position of the first returned entry in the dataset.

inheritedtotal

total: number

Total count of entries.

Page Options