CursorPaginator

Source

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

Hierarchy

Paginator<
An object with these properties:
Property Type Description
cursor string
pageSize number
,
An object with these properties:
Property Type Description
nextCursor string|null
previousCursor string|null
>
CursorPaginator

An object with these properties:
	cursor	string
	pageSize	number

An object with these properties:
	nextCursor	string\|null
	previousCursor	string\|null

API

Show inherited

Constructor

new CursorPaginator(?currentStatePair,?internalStatePair)

Params:

	Parameter	Type	Description
	currentStatePair	null
	internalStatePair	null

Methods

first()

Returns:void

firstState()

Returns:


Property	Type	Description
cursor	string
pageSize	number

getRequestInit(props)

Params:

	Parameter	Type	Description
*	props An object with the properties below
	props.headers	HeadersInit\|Record
	props.query	Record
	props.urlArgs	Record
	...	any	Any properties from RequestInit

Returns:


Property	Type	Description
headers	HeadersInit\|Record
query	Record
urlArgs	Record
...	any	Any properties from RequestInit

hasNextPage()

Returns:boolean

next()

Returns:void

nextState()

Returns:null|


Property	Type	Description
cursor	string
pageSize	number

pageSizeState(pageSize)

Params:

	Parameter	Type	Description
*	pageSize	null\|number

Returns:


Property	Type	Description
cursor	string
pageSize	number

previous()

Returns:void

previousState()

Returns:null|


Property	Type	Description
cursor	string
pageSize	number

replaceStateControllers(currentStatePair,internalStatePair)

Params:

	Parameter	Type	Description
*	currentStatePair	any
*	internalStatePair	any

Returns:void

setCurrentState(set)

Params:

	Parameter	Type	Description
*	set

Returns:void

setInternalState(set)

Params:

	Parameter	Type	Description
*	set

Returns:void

setPageSize(pageSize)

Params:

	Parameter	Type	Description
*	pageSize	null\|number

Returns:void

setResponse(props)

Params:

	Parameter	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)

Params:

	Parameter	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

API

Constructor

Methods

Properties

currentState

cursor

internalState

nextCursor

pageSize

previousCursor

responseIsSet

Static Methods