react-ketting/dist/hooks/use-paged-collection.d.ts

Ketting bindings for React

import { Resource } from 'ketting';
import { ResourceLike } from '../util';
import { UseCollectionOptions } from './use-collection';
/**
 * The result of a useCollection hook.
 */
declare type UsePagedCollectionResponse<T> = {
    /**
     * True if we are loading the initial page, or additional pages.
     */
    loading: boolean;
    /**
     * Will contain an Error object if an error occurred anywhere in the
     */
    error: Error | null;
    /**
     * List of collection members.
     *
     * This starts off as an empty array.
     */
    items: Resource<T>[];
    /**
     * Will be set to true if there are more pages on the API.
     */
    hasNextPage: boolean;
    /**
     * Call this function to load the next page. If there are no next pages,
     * a warning will be emitted.
     */
    loadNextPage: () => void;
};
/**
 * The usePagedCollection hook works similar to useCollection, but has the
 * ability to load in additional pages of items.
 *
 * For this to work, the API needs to expose a "next" link on the collection.
 * As long as there are "next" links, more pages can be loaded in.
 *
 * Additional items from collection pages will be appended to "items",
 * allowing frontends to build 'infinite scroll' features.
 *
 * Example call:
 *
 * <pre>
 *   const {
 *     loading,
 *     error,
 *     items,
 *     hasNextPage,
 *     loadNextPage
 *  } = usePagedResource<Article>(resource);
 * </pre>
 *
 * The resource may be passed as a Resource object, a Promise<Resource>, or a
 * uri string.
 *
 * Returned properties:
 *
 * * loading - will be true every time we're going to the server and fetch a
 *             a new page.
 * * error - Will be null or an error object.
 * * items - Will contain an array of resources, each typed Resource<T> where
 *           T is the passed generic argument.
 * * hasNextPage - Will be true if the server has another page.
 * * loadNextPage - Loads the next page, and appends the new items to the
 *                  items array.
 */
export declare function usePagedCollection<T = any>(resourceLike: ResourceLike<any>, options?: UseCollectionOptions): UsePagedCollectionResponse<T>;
export {};