Interface PaginatedResult<T>

Represents the result of a paginated query.

interface PaginatedResult<T> {
    items: T[];
    current(): Promise<PaginatedResult<T>>;
    first(): Promise<PaginatedResult<T>>;
    hasNext(): boolean;
    isLast(): boolean;
    next(): Promise<null | PaginatedResult<T>>;
}

Type Parameters

T

Index

Properties

Methods

current first hasNext isLast next

Properties

items

items: T[]

The items returned by the query.

Methods

current

current(): Promise<PaginatedResult<T>>
Fetches the current page of items (the same as the current page).

Returns Promise<PaginatedResult<T>>
A promise that resolves with the current page of items.
- Defined in src/core/query.ts:43

first

first(): Promise<PaginatedResult<T>>
Fetches the first page of items.

Returns Promise<PaginatedResult<T>>
A promise that resolves with the first page of items.
- Defined in src/core/query.ts:36

hasNext

hasNext(): boolean
Whether there are more items to query.

Returns boolean
true if there are more items to query, false otherwise.
- Defined in src/core/query.ts:15

isLast

isLast(): boolean
Whether this is the last page of items.

Returns boolean
true if this is the last page of items, false otherwise.
- Defined in src/core/query.ts:22

next

next(): Promise<null | PaginatedResult<T>>
Fetches the next page of items.

Returns Promise<null | PaginatedResult<T>>
A promise that resolves with the next page of items or null if there are no more items.
- Defined in src/core/query.ts:29