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 };
}

Index

Methods

nextPage previousPage registerNumberOfResults registerPage updateNumberOfResults updatePage

Methods

nextPage(): { payload: void; type: string }
Updates the page to the next page.

Returns { payload: void; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/pagination/pagination-actions-loader.ts:25

previousPage(): { payload: void; type: string }
Updates the page to the previous page.

Returns { payload: void; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/pagination/pagination-actions-loader.ts:32

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.
- Defined in packages/headless/src/features/pagination/pagination-actions-loader.ts:40

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.
- Defined in packages/headless/src/features/pagination/pagination-actions-loader.ts:48

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.
- Defined in packages/headless/src/features/pagination/pagination-actions-loader.ts:56

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.
- Defined in packages/headless/src/features/pagination/pagination-actions-loader.ts:64

Interface PaginationActionCreators

Index

Methods

Methods

nextPage

Returns { payload: void; type: string }

previousPage

Returns { payload: void; type: string }

registerNumberOfResults

Parameters

Returns { payload: number; type: string }

registerPage

Parameters

Returns { payload: number; type: string }

updateNumberOfResults

Parameters

Returns { payload: number; type: string }

updatePage

Parameters

Returns { payload: number; type: string }

Settings

On This Page