@simbachain/libsimba-js/src/simba/pagedresponse.js

libsimba-js is a library simplifying the use of SIMBAChain APIs. We aim to abstract away the various blockchain concepts, reducing the necessary time needed to get to working code.

/**
 * Wrapper for paged responses
 */
export default class PagedResponse {
    /**
     * Wrapper for paged responses
     * @param {Object} data - The response
     * @param {URL} url - The URL that provided the response
     * @param {SimbaBase} simba - The SimbaBase instance that requested the response
     */
    constructor(data, url, simba){
        this.url = new URL(url).toString();
        this._count = data.count;
        this._next_page = data.next;
        this._previous_page = data.previous;
        this.results = data.results;
        this.simba = simba;
    }

    /**
     * Grab the next page
     * @returns {Promise<PagedResponse> | null} - Null if there's no next page
     */
    async next(){
        if(!this._next_page) return null;
        return this.simba.sendTransactionRequest(new URL(this._next_page).toString());
    }

    /**
     * Grab the previous page
     * @returns {Promise<PagedResponse> | null} - Null if there's no next page
     */
    async previous(){
        if(!this._previous_page) return null;
        return this.simba.sendTransactionRequest(new URL(this._previous_page).toString());
    }

    /**
     * Returns the actual data
     * @returns {Object}
     */
    data(){
        return this.results;
    }

    /**
     * Returns the result count
     * @returns {number}
     */
    count(){
        return this._count;
    }

    /**
     * Returns the current page number
     * @returns {number}
     */
    current_page(){
        return this.url.searchParams.get('page');
    }

    /**
     * Returns the next page number
     * @returns {number}
     */
    next_page(){
        return this._next_page;
    }

    /**
     * Returns the previous page number
     * @returns {number}
     */
    previous_page(){
        return this._previous_page;
    }
}