aboutsummaryrefslogtreecommitdiff
path: root/src/main/scala/xyz/driver/restquery/query/Pagination.scala
blob: 07db5348b04b95bbb5fc8c9e5c735783c688e230 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
package xyz.driver.restquery.query

/**
  * @param pageNumber Starts with 1
  */
final case class Pagination(pageSize: Int, pageNumber: Int) {
  def offset: Int = pageSize * (pageNumber - 1)
}

object Pagination {

  // @see https://driverinc.atlassian.net/wiki/display/RA/REST+API+Specification#RESTAPISpecification-CommonRequestQueryParametersForWebServices
  val Default = Pagination(pageSize = 100, pageNumber = 1)
}