Wondering what’s next for npm?Check out our public roadmap! »

    @writetome51/loaded-page
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.1 • Public • Published

    LoadedPage

    A TypeScript/Javascript class intended to help a separate Paginator
    paginate data that can't all be stored in memory at once.

    Instantiation

    // Use this factory function:
    
    getInstance_LoadedPage(
        params: {
            dataSource: {
    
                // If `isLastLoad` is true, it must only return the remaining items in the dataset and
                // ignore `itemsPerLoad`.
    
                getLoad: (
                    loadNumber: number, itemsPerLoad: number, isLastLoad: boolean
                ) => Promise<any[]>;
            };
    
            pageInfo: {
                setItemsPerPage: (num) => void;
                getItemsPerPage: () => number;
                getTotalPages: () => number;        
            };
    
            loadInfo: {
                getCurrentLoadNumber: () => number;
                setCurrentLoadNumber: (num) => void;
                getItemsPerLoad: () => number;
                currentLoadIsLast: () => boolean;
                getPagesPerLoad: () => number;
            };
        }
    ): LoadedPage

    Methods

    view methods
    set(pageNumber): Promise<void>
        // After calling this, get the page's contents by calling this.get().
    
    reset(pageNumber): Promise<void>
        // Even if 'pageNumber' is already the loaded page, the 
        // data containing that page is reloaded from the source.
    
    get(): any[]
        // returns the page contents.
    
    getNumber(): number
        // returns page number.

    Installation

    npm i @writetome51/loaded-page

    Loading

    import { LoadedPage, getInstance_LoadedPage } from '@writetome51/loaded-page';

    License

    MIT

    Install

    npm i @writetome51/loaded-page

    DownloadsWeekly Downloads

    1

    Version

    0.1.1

    License

    MIT

    Unpacked Size

    11.9 kB

    Total Files

    11

    Last publish

    Collaborators

    • avatar