InferredPaginator

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

API

Show inherited

Constructor

new InferredPaginator(currentStatePair,internalStatePair)

Params:

	Parameter	Type	Description
*	currentStatePair	any
*	internalStatePair	any

Methods

first()

Returns:void

firstState()

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


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


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

getRequestInit(currentInit)

Params:

	Parameter	Type	Description
*	currentInit	any

Returns:


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

hasNextPage()

Returns:boolean

last()

Returns:void

lastState()

Returns:null|


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


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

limitState(limit)

Params:

	Parameter	Type	Description
*	limit	null\|number

Returns:null|


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

next()

Returns:void

nextState()

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


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


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

offsetState(offset)

Params:

	Parameter	Type	Description
*	offset	null\|number

Returns:null|


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

pageSizeState(pageSize)

Params:

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

Params:

	Parameter	Type	Description
*	page	number

Returns:null|


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

previous()

Returns:void

previousState()

Returns:null|


Property	Type	Description
cursor	string
pageSize	number


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


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

replaceStateControllers(props,props)

Params:

	Parameter	Type	Description
*	props	[any, any]
*	props	[any, any]

Returns:void

setCurrentState(nextValue)

Params:

	Parameter	Type	Description
*	nextValue	\|\|

Returns:void

setInternalState(set)

Params:

	Parameter	Type	Description
*	set

Returns:void

setLimit(limit)

Params:

	Parameter	Type	Description
*	limit	null\|number

Returns:void

setOffset(offset)

Params:

	Parameter	Type	Description
*	offset	null\|number

Returns:void

setPage(page)

Params:

	Parameter	Type	Description
*	page	number

Returns:void

setPageSize(pageSize)

Params:

	Parameter	Type	Description
*	pageSize	null\|number

Returns:void

setResponse(response)

Params:

	Parameter	Type	Description
*	response	Record

Returns:void

Properties

__paginator

Source

CursorPaginator|PageNumberPaginator|LimitOffsetPaginator

currentState

Source


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


Property	Type	Description
cursor	string
pageSize	number


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

cursor

Source

null|string

internalState

Source

Record

limit

Source

null|number

nextCursor

Source

null|string

offset

Source

null|number

page

Source

null|number

pageSize

Source

null|number

paginator

Source

undefined|CursorPaginator|PageNumberPaginator|LimitOffsetPaginator

previousCursor

Source

null|string

responseIsSet

Source

boolean

total

Source

null|number

totalPages

Source

null|number

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

__paginator

currentState

cursor

internalState

limit

nextCursor

offset

page

pageSize

paginator

previousCursor

responseIsSet

total

totalPages

Static Methods