Network.JSONApi.Pagination

Documentation

data Pagination

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

Constructors

Pagination

Fields

• getPaginationPageSize :: PageSize
• getPaginationPageNum :: PageNum
• getPaginationResourceCount :: ResourceCount

Instances

ToJSON Pagination

Defined in Network.JSONApi.Pagination

Methods

toJSON :: Pagination -> Value

toEncoding :: Pagination -> Encoding

toJSONList :: [Pagination] -> Value

toEncodingList :: [Pagination] -> Encoding

MetaObject Pagination

Pagination can be used as a meta object if required in addition to the links generated for paging.

Defined in Network.JSONApi.Pagination

Methods

typeName :: Pagination -> Text

newtype PageNum

Constructors

PageNum

Fields

• getPageNum :: Int

Instances

Show PageNum

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> PageNum -> ShowS

show :: PageNum -> String

showList :: [PageNum] -> ShowS

newtype PageSize

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

Constructors

PageSize

Fields

• getPageSize :: Int

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 :: Int

Instances

Show ResourceCount

Defined in Network.JSONApi.Pagination

Methods

showsPrec :: Int -> ResourceCount -> ShowS

show :: ResourceCount -> String

showList :: [ResourceCount] -> ShowS