LimitOffsetPaginator

Source

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

Hierarchy

Paginator<,>
LimitOffsetPaginator

Examples

Paginate manually

Use with usePaginator & paginationMiddleware

Store pagination state in the URL.

API

Show inherited

Constructor

new LimitOffsetPaginator(?currentStatePair,?internalStatePair)

Source

Arguments:

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

Methods

first()

Source

Returns:void

firstState()

Source

Returns:


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

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

limitState(limit)

Source

Arguments:

	Argument	Type	Description
*	limit	null\|number

Returns:


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

next()

Source

Returns:void

nextState()

Source

Returns:null|


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

offsetState(offset)

Source

Arguments:

	Argument	Type	Description
*	offset	null\|number

Returns:


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

previous()

Source

Returns:void

previousState()

Source

Returns:null|


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

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

setLimit(limit)

Source

Arguments:

	Argument	Type	Description
*	limit	null\|number

Returns:void

setOffset(offset)

Source

Arguments:

	Argument	Type	Description
*	offset	null\|number

Returns:void

setResponse(props)

Source

Arguments:

	Argument	Type	Description
*	props

Returns:void

Properties

currentState

Source


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

internalState

Source


Property	Type	Description
responseIsSet	boolean
total	number\|null

limit

Source

null|number

offset

Source

number

responseIsSet

Source

boolean

total

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

limit

offset

responseIsSet

total

Static Methods

Arguments: