Retree - v1.0.0
    Preparing search index...

    Interface PaginationResult<T>

    The result of paginating using OrderedQuery.paginate.

    interface PaginationResult<T> {
        continueCursor: string;
        isDone: boolean;
        page: T[];
        pageStatus?: "SplitRecommended" | "SplitRequired" | null;
        splitCursor?: string | null;
    }

    Type Parameters

    • T
    Index

    Properties

    continueCursor isDone page pageStatus? splitCursor?

    Properties

    continueCursor: string

    A Cursor to continue loading more results.

    isDone: boolean

    Have we reached the end of the results?

    page

    page: T[]

    The page of results.

    pageStatus?: "SplitRecommended" | "SplitRequired" | null

    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'.

    splitCursor?: string | null

    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].

    Settings

    Member Visibility

    On This Page

    Properties