Paginator

Go to the first page.

Return the state for the first page

Does not transition state. To transition state call first instead.

Return the options to use with Endpoint.execute or Endpoint.prepare. Usually this just involves setting query to the query string parameters for the paginator but can also provide custom headers or different URL resolve arguments.

Returns true if there's more results after the current page

Go to the next page.

Return the state for the next page

Does not transition state. To transition state call next instead.

Go to the previous page.

Return the state for the previous page

Does not transition state. To transition state call previous instead.

Paginator receives 2 tuples of a state and state setter pair. This is expected to match the same interface as useState in React. The following is a valid simple usage:

const paginator = new Paginator(useState(), useState());

Note that we can also pass the state controllers in via replaceStateControllers rather than in the constructor. This is so we can memoize the Paginator instance which is desirable when using the paginator as a dependency to React hooks.

As state is passed in and managed external to the class be aware that any data stored on the class instance will be lost unless written with setCurrentState or setInternalState. This design is a compromise between allowing a clear interface for how paginators should be defined and allowing the state to be managed externally (eg. using React state).

This is called when an Endpoint has resolved and is passed the response from the endpoint. This is used to update the relevant paginator state - eg. the total number of records, next & previous cursors etc.