InferredPaginator

Source

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

InferredPaginator<InferredPaginatorT = CursorPaginator|PageNumberPaginator|LimitOffsetPaginator>

Examples

Paginate manually

Use with usePaginator & paginationMiddleware

Store pagination state in the URL.

API

Constructor

new InferredPaginator(currentStatePair,internalStatePair)

Source

Arguments:

	Argument	Type	Description
*	currentStatePair	any
*	internalStatePair	any

Methods

first()

Source

Returns:void

firstState()

Source

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


Property	Type	Description
limit	number\|string
offset	number\|string


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

getRequestInit(currentInit)

Source

Arguments:

	Argument	Type	Description
*	currentInit	any

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
limit	number\|string
offset	number\|string


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

limitState(limit)

Source

Arguments:

	Argument	Type	Description
*	limit	null\|number

Returns:null|


Property	Type	Description
limit	number\|string
offset	number\|string

next()

Source

Returns:void

nextState()

Source

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


Property	Type	Description
limit	number\|string
offset	number\|string


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

offsetState(offset)

Source

Arguments:

	Argument	Type	Description
*	offset	null\|number

Returns:null|


Property	Type	Description
limit	number\|string
offset	number\|string

pageSizeState(pageSize)

Source

Arguments:

	Argument	Type	Description
*	pageSize	null\|number

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


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

pageState(page)

Source

Arguments:

	Argument	Type	Description
*	page	number

Returns:null|


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

previous()

Source

Returns:void

previousState()

Source

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


Property	Type	Description
limit	number\|string
offset	number\|string


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

replaceStateControllers(props,props)

Source

Arguments:

	Argument	Type	Description
*	props	[State, ]
*	props	[State, ]

Returns:void

setCurrentState(nextValue)

Source

Arguments:

	Argument	Type	Description
*	nextValue	Object

Returns:void

setInternalState(set)

Source

Arguments:

	Argument	Type	Description
*	set	Object

Returns:void

setLimit(limit)

Source

Arguments:

	Argument	Type	Description
*	limit	null\|number

Returns:void

setOffset(offset)

Source

Arguments:

	Argument	Type	Description
*	offset	null\|number

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(response)

Source

Arguments:

	Argument	Type	Description
*	response	Record

Returns:void

Properties

__paginator

Source

InferredPaginatorT

currentState

Source

Object

cursor

Source

null|string

internalState

Source


Property	Type	Description
paginatorClass	any
responseIsSet	boolean
...	any	Any properties from Object

limit

Source

null|number

nextCursor

Source

null|string

offset

Source

null|number

page

Source

null|number

pageSize

Source

null|number

paginator

Source

undefined|InferredPaginatorT

previousCursor

Source

null|string

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:

Arguments:

Arguments:

Arguments:

Arguments:

Properties

__paginator

currentState

cursor

internalState

limit

nextCursor

offset

page

pageSize

paginator

previousCursor

responseIsSet

total

totalPages

Static Methods

Arguments: