import { type Maybe } from '../value/maybe.type'; /** * Page value used when no list items have been loaded. */ export declare const UNLOADED_PAGE = -1; /** * The first page of results. */ export declare const FIRST_PAGE = 0; /** * Page value used when there are no elements left to load. */ export declare const FINAL_PAGE = -2; /** * Numeric page identifier. */ export type PageNumber = number; /** * Represents a page number. */ export interface Page { /** * Current page number. */ page: PageNumber; } /** * Extracts the page number from a {@link Page} object, returning {@link UNLOADED_PAGE} if the input is nullish. * * @param page - Page object to read from * @returns The page number, or {@link UNLOADED_PAGE} (-1) if not provided */ export declare function getPageNumber(page: Maybe>): number; /** * Returns the next sequential page number after the given page. * * @param page - Current page object * @returns The current page number plus one */ export declare function getNextPageNumber(page: Maybe>): number; /** * Checks whether the given page represents the final page of results. * * @param page - Page object to check * @returns `true` if the page number equals {@link FINAL_PAGE} */ export declare function isFinalPage(page: Maybe>): boolean;