Interface: PaginationResult<T>
server.PaginationResult
The result of paginating using paginate.
Type parameters
| Name |
|---|
T |
Properties
page
• page: T[]
The page of results.
Defined in
isDone
• isDone: boolean
Have we reached the end of the results?
Defined in
continueCursor
• continueCursor: string
A Cursor to continue loading more results.
Defined in
splitCursor
• Optional splitCursor: null | string
A Cursor to split the page into two, so the page from (cursor, continueCursor] can be replaced by two pages (cursor, splitCursor] and (splitCursor, continueCursor].
Defined in
pageStatus
• Optional pageStatus: null | "SplitRecommended" | "SplitRequired"
When a query reads too much data, it may return 'SplitRecommended' to
indicate that the page should be split into two with splitCursor.
When a query reads so much data that page might be incomplete, its status
becomes 'SplitRequired'.