Network.JSONApi.Pagination

Documentation

data Pagination

Wrapper type for the various components of pagination being page size, page index and the number of resources in total.

Constructors

Pagination

Fields

• getPaginationPageIndex :: PageIndex
• getPaginationPageSize :: PageSize
• getPaginationResourceCount :: ResourceCount

newtype PageIndex

Constructors

PageIndex

Fields

• getPageIndex :: Word

Instances

Show PageIndex

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> PageIndex -> ShowS

show :: PageIndex -> String

showList :: [PageIndex] -> ShowS

newtype PageSize

We can specify limits on the number of rows we would like back from the database

Constructors

PageSize

Fields

• getPageSize :: Word

Instances

Show PageSize

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> PageSize -> ShowS

show :: PageSize -> String

showList :: [PageSize] -> ShowS

newtype ResourceCount

Constructors

ResourceCount

Fields

• getResourceCount :: Word

Instances

Show ResourceCount

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> ResourceCount -> ShowS

show :: ResourceCount -> String

showList :: [ResourceCount] -> ShowS

data Strategy

Pagination strategies are commonly implemented by the server of which Page and Offset are commonly used.

Constructors

PageStrategy

OffsetStrategy

mkPaginationLinks :: Strategy -> URL -> Pagination -> Links

Helper function to build relative links for a collection of resources of type ResourceEntity.

This helper function assumes that the first page is always page 0.