Interface PaginationActionCreators

The pagination action creators.

interface PaginationActionCreators {
    nextPage(): { payload: void; type: string };
    previousPage(): { payload: void; type: string };
    registerNumberOfResults(
        numberOfResults: number,
    ): { payload: number; type: string };
    registerPage(page: number): { payload: number; type: string };
    updateNumberOfResults(
        numberOfResults: number,
    ): { payload: number; type: string };
    updatePage(page: number): { payload: number; type: string };
}

Methods

nextPage previousPage registerNumberOfResults registerPage updateNumberOfResults updatePage

Methods

nextPage

  • nextPage(): { payload: void; type: string }

  • Updates the page to the next page.

    Returns { payload: void; type: string }

    A dispatchable action.

previousPage

  • previousPage(): { payload: void; type: string }

  • Updates the page to the previous page.

    Returns { payload: void; type: string }

    A dispatchable action.

registerNumberOfResults

  • registerNumberOfResults(
        numberOfResults: number,
    ): { payload: number; type: string }

  • Initializes the numberOfResults query parameter. For more information, refer to the documentation on query parameters.

    Parameters

    • numberOfResults: number

      The initial number of results.

    Returns { payload: number; type: string }

    A dispatchable action.

registerPage

  • registerPage(page: number): { payload: number; type: string }

  • Sets the initial page by initializing the firstResult query parameter. For more information, refer to the documentation on query parameters.

    Parameters

    • page: number

      The initial page number.

    Returns { payload: number; type: string }

    A dispatchable action.

updateNumberOfResults

  • updateNumberOfResults(
        numberOfResults: number,
    ): { payload: number; type: string }

  • Updates the numberOfResults query parameter. For more information, refer to the documentation on query parameters.

    Parameters

    • numberOfResults: number

      The new number of results.

    Returns { payload: number; type: string }

    A dispatchable action.

updatePage

  • updatePage(page: number): { payload: number; type: string }

  • Updates the page by updating the firstResult query parameter. For more information, refer to the documentation on query parameters.

    Parameters

    • page: number

      The new page number.

    Returns { payload: number; type: string }

    A dispatchable action.

Settings

Member Visibility

On This Page

Methods