Interface ResultsPerPage

The ResultsPerPage controller allows the end user to choose how many results to display per page.

Example: results-per-page.fn.tsx

interface ResultsPerPage {
    state: ResultsPerPageState;
    isSetTo(num: number): boolean;
    set(num: number): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- ResultsPerPage

Index

Methods

isSetTo set subscribe

Properties

Methods

isSetTo

isSetTo(num: number): boolean
Checks whether the number of results per page is equal to the specified number.
Parameters
- num: number
  The number of results.
Returns boolean
true if the number of results is equal to the passed value, and false otherwise.
- Defined in packages/headless/dist/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts:35

set

set(num: number): void
Updates the number of results to request per page.
Parameters
- num: number
  The number of results.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/results-per-page/headless-core-results-per-page.d.ts:29

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: ResultsPerPageState

The state of the ResultsPerPage controller.