Interface FindPage<T>

Overview

Represents a page of results returned by the Data API when using pagination in find operations.

This interface encapsulates all the information returned from a single page fetch, including the actual data fetched & mapped, the pagination state, and the sort vector if applicable.

✏️Note: This interface is primarily used with the FindCursor.initialPageState and FindCursor.fetchNextPage methods, which provide direct access to the underlying pagination mechanisms.

Example

// Server-side code
async function getPageOfResults(pageState?: string) {
  const cursor = collection.find({ status: 'active' })
    .initialPageState(pageState);

  const page = await cursor.fetchNextPage();

  return {
    nextPageState: page.nextPageState,
    results: page.result,
  };
}

// Client can then use the nextPageState to fetch subsequent pages
Copy

See

• FindCursor.initialPageState
• FindCursor.fetchNextPage