CursorPaginator

Source

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

Hierarchy

Paginator<,>
CursorPaginator

Examples

Paginate manually

Use with usePaginator & paginationMiddleware

Store pagination state in the URL.

API

Show inherited

Constructor

new CursorPaginator(?currentStatePair,?internalStatePair)

Source

Arguments:

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

Methods

first()

Source

Returns:void

firstState()

Source

Returns:


Property	Type	Description
cursor	string
pageSize	number

getRequestInit(props)

Source

Arguments:

	Argument	Type
*	props An object with the properties below
	props.body	null\|BodyInit
	props.cache	RequestCache
	props.credentials	RequestCredentials
	props.headers	HeadersInit\|Record
	props.integrity	string
	props.keepalive	boolean
	props.method	string
	props.mode	RequestMode
	props.query	Record
	props.redirect	RequestRedirect
	props.referrer	string
	props.referrerPolicy	ReferrerPolicy
	props.signal	null\|AbortSignal
	props.urlArgs	Record
	props.window	null

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

next()

Source

Returns:void

nextState()

Source

Returns:null|


Property	Type	Description
cursor	string
pageSize	number

pageSizeState(pageSize)

Source

Arguments:

	Argument	Type	Description
*	pageSize	null\|number

Returns:


Property	Type	Description
cursor	string
pageSize	number

previous()

Source

Returns:void

previousState()

Source

Returns:null|


Property	Type	Description
cursor	string
pageSize	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

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
cursor	string
pageSize	number

cursor

Source

null|string

internalState

Source


Property	Type	Description
nextCursor	string\|null
previousCursor	string\|null
responseIsSet	boolean

nextCursor

Source

null|string

pageSize

Source

null|number

previousCursor

Source

null|string

responseIsSet

Source

boolean

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:

Properties

currentState

cursor

internalState

nextCursor

pageSize

previousCursor

responseIsSet

Static Methods

Arguments: