PageNumberPaginator

Source

import { PageNumberPaginator } from "@prestojs/util";

Hierarchy

Paginator<,>
PageNumberPaginator

Examples

Paginate manually

Use with usePaginator & paginationMiddleware

Store pagination state in the URL.

API

Show inherited

Constructor

new PageNumberPaginator(?currentStatePair,?internalStatePair)

Source

Arguments:

	Argument	Type	Description
	currentStatePair	null\|[State, ]
	internalStatePair	null\|[State, ]

Methods

first()

Source

Returns:void

firstState()

Source

Returns:


Property	Type	Description
page	string\|number
pageSize	string\|number

getRequestInit(props)

Source

Arguments:

	Argument	Type	Description
*	props	Object

Returns:


Property	Type	Description
body	null\|BodyInit
cache	RequestCache
credentials	RequestCredentials
headers	HeadersInit\|Record
integrity	string
keepalive	boolean
method	string
mode	RequestMode
query	Record
redirect	RequestRedirect
referrer	string
referrerPolicy	ReferrerPolicy
signal	null\|AbortSignal
urlArgs	Record
window	null

hasNextPage()

Source

Returns:boolean

hasPreviousPage()

Source

Returns:boolean

last()

Source

Returns:void

lastState()

Source

Returns:null|


Property	Type	Description
page	string\|number
pageSize	string\|number

next()

Source

Returns:void

nextState()

Source

Returns:


Property	Type	Description
page	string\|number
pageSize	string\|number

pageSizeState(pageSize)

Source

Arguments:

	Argument	Type	Description
*	pageSize	null\|number

Returns:


Property	Type	Description
page	string\|number
pageSize	string\|number

pageState(page)

Source

Arguments:

	Argument	Type	Description
*	page	number

Returns:


Property	Type	Description
page	string\|number
pageSize	string\|number

previous()

Source

Returns:void

previousState()

Source

Returns:


Property	Type	Description
page	string\|number
pageSize	string\|number

replaceStateControllers(currentStatePair,internalStatePair)

Source

Arguments:

	Argument	Type	Description
*	currentStatePair	[State, ]
*	internalStatePair	[State, ]

Returns:void

setCurrentState(set)

Source

Arguments:

	Argument	Type	Description
*	set

Returns:void

setInternalState(set)

Source

Arguments:

	Argument	Type	Description
*	set

Returns:void

setPage(page)

Source

Arguments:

	Argument	Type	Description
*	page	number

Returns:void

setPageSize(pageSize)

Source

Arguments:

	Argument	Type	Description
*	pageSize	null\|number

Returns:void

setResponse(props)

Source

Arguments:

	Argument	Type	Description
*	props

Returns:void

Properties

currentState

Source


Property	Type	Description
page	string\|number
pageSize	string\|number

internalState

Source


Property	Type	Description
responseIsSet	boolean
total	number\|null

page

Source

null|number

pageSize

Source

null|number

responseIsSet

Source

boolean

total

Source

null|number

totalPages

Source

null|number

Static Methods

getPaginationState(requestDetails)

Source

Arguments:

	Argument	Type
*	requestDetails An object with the properties below
	requestDetails.decodedBody	any
	requestDetails.query	Record
	requestDetails.response	Response
*	requestDetails.url	string
	requestDetails.urlArgs	Record

Returns:false|Record

On this page

Examples

Paginate manually

Use with usePaginator & paginationMiddleware

Store pagination state in the URL.

API

Constructor

Arguments:

Methods

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Properties

currentState

internalState

page

pageSize

responseIsSet

total

totalPages

Static Methods

Arguments: