yola / drf-paginator Goto Github PK

The goal is to make pagination easier to deal with for our clients. Clients have request functions in the form of request(queryParams) that return a promise for the response.

Paginator Object

The paginator wraps a request and provides a clean API for returning promises for the results of each page.

• new Paginator(request, queryParams): constructor that takes a request and query params for said request
• paginator.next(): returns the next page.
  • Initial call should either be page 1 or the page given as a key on queryParams during initialization of the paginator.
  • Caches responses to prevent duplicate requests
• paginator.previous(): returns the previous page
  • Functions much like next in that it will return cached responses or make new requests

Static methods:

• Paginator.all(request, queryParams): returns a promise for all the pages of an endpoint concatenated together as a single result list

While not needed for MVP, we'd like the paginator object to support the additional methods:

• paginator.first(): returns the first page and sets the current page to the first one
• paginator.last(): returns the last page and sets current page to it
• paginator.current(): returns the current page, which should be the same promise that was last returned by next or previous.