Presto

InferredPaginator

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

Class that infers the specific type of pagination based on the response.

Supports PageNumberPaginator, LimitOffsetPaginator and CursorPaginator with the following rules based on the response data:

API

Constructor

new InferredPaginator(currentStatePair,internalStatePair)

Source
ParameterTypeDescription
*currentStatePairany
*internalStatePairany

Methods

first()

Source

Go to the first page.

Returns
void

firstState()

Source

Return the state for the first page

Does not transition state. To transition state call first instead.

Returns

One of the following:

LimitOffsetPaginationState
KeyTypeDescription
limitnumber|string
offsetnumber|string

OR

CursorPaginationState
KeyTypeDescription
cursorstring
pageSizenumber

OR

PageNumberPaginationState
KeyTypeDescription
pagestring|number
pageSizestring|number

OR

null

getRequestInit(currentInit)

Source
ParameterTypeDescription
*currentInitany
Returns
PaginatorRequestOptions
KeyTypeDescription
headersHeadersInit|Record

Any headers to add to the request. You can unset default headers that might be specified in the default Endpoint.defaultConfig.requestInit by setting the value to undefined.

queryRecord

Any query request parameters

urlArgsRecord

Any arguments for the URL

hasNextPage()

Source

Returns true if there's more results after the current page

Returns
boolean

last()

Source

Go to the last page. If the last page isn't yet known (eg. results haven't yet been returned) then null will be returned.

If the last page is not yet known because results haven't been returned this function does nothing. Not valid for CursorPaginator

Returns
void

lastState()

Source

Return the state for the first page

Does not transition state. To transition state call last instead.

Not valid for CursorPaginator

Returns

One of the following:

LimitOffsetPaginationState
KeyTypeDescription
limitnumber|string
offsetnumber|string

OR

PageNumberPaginationState
KeyTypeDescription
pagestring|number
pageSizestring|number

OR

null

limitState(limit)

Source

Only valid if inferred paginator is LimitOffsetPaginator.

See LimitOffsetPaginator.limitState

ParameterTypeDescription
*limitnumber|null
Returns

One of the following:

LimitOffsetPaginationState
KeyTypeDescription
limitnumber|string
offsetnumber|string

OR

null

next()

Source

Go to the next page.

Returns
void

nextState()

Source

Return the state for the next page

Does not transition state. To transition state call next instead.

Returns

One of the following:

LimitOffsetPaginationState
KeyTypeDescription
limitnumber|string
offsetnumber|string

OR

CursorPaginationState
KeyTypeDescription
cursorstring
pageSizenumber

OR

PageNumberPaginationState
KeyTypeDescription
pagestring|number
pageSizestring|number

OR

null

offsetState(offset)

Source

Only valid if inferred paginator is LimitOffsetPaginator.

See LimitOffsetPaginator.offsetState

ParameterTypeDescription
*offsetnumber|null
Returns

One of the following:

LimitOffsetPaginationState
KeyTypeDescription
limitnumber|string
offsetnumber|string

OR

null

pageSizeState(pageSize)

Source

Only valid if inferred paginator is PageNumberPaginator.

See PageNumberPaginator.pageSizeState

ParameterTypeDescription
*pageSizenumber|null
Returns

One of the following:

CursorPaginationState
KeyTypeDescription
cursorstring
pageSizenumber

OR

PageNumberPaginationState
KeyTypeDescription
pagestring|number
pageSizestring|number

OR

null

pageState(page)

Source

Only valid if inferred paginator is PageNumberPaginator.

See PageNumberPaginator.pageState

ParameterTypeDescription
*pagenumber
Returns

One of the following:

PageNumberPaginationState
KeyTypeDescription
pagestring|number
pageSizestring|number

OR

null

previous()

Source

Go to the previous page.

Returns
void

previousState()

Source

Return the state for the previous page

Does not transition state. To transition state call previous instead.

Returns

One of the following:

LimitOffsetPaginationState
KeyTypeDescription
limitnumber|string
offsetnumber|string

OR

CursorPaginationState
KeyTypeDescription
cursorstring
pageSizenumber

OR

PageNumberPaginationState
KeyTypeDescription
pagestring|number
pageSizestring|number

OR

null

replaceStateControllers(props,props)

Source
ParameterTypeDescription
*__namedParameters[any, any]
*__namedParameters[any, any]
Returns
void

setLimit(limit)

Source

Only valid if inferred paginator is LimitOffsetPaginator.

See LimitOffsetPaginator.setLimit

ParameterTypeDescription
*limitnumber|null
Returns
void

setOffset(offset)

Source

Only valid if inferred paginator is LimitOffsetPaginator.

See LimitOffsetPaginator.setOffset

ParameterTypeDescription
*offsetnumber|null
Returns
void

setPage(page)

Source

Only valid if inferred paginator is PageNumberPaginator.

See PageNumberPaginator.setPage

ParameterTypeDescription
*pagenumber
Returns
void

setPageSize(pageSize)

Source

Only valid if inferred paginator is PageNumberPaginator.

See PageNumberPaginator.setPageSize

ParameterTypeDescription
*pageSizenumber|null
Returns
void

setResponse(response)

Source

Sets the internal data based on response. This is where the paginator is inferred based on values in the response.

See getPaginationState for how to customise this if your backend implementation differs.

ParameterTypeDescription
*responseRecord
Returns
void

Static Methods

getPaginationState(requestDetails)

Source
ParameterTypeDescription
requestDetails.decodedBodyany

The value returned by decodedBody. See Endpoint.execute.

This may be a sub-key of the data returned by Endpoint.execute, eg. if the path option is used in paginationMiddleware. eg. If decodedBody from the Endpoint was

{
    users: {
        count: 10,
        results: [...],
    }
    extraDetails: {...}
}

and paginationMiddleware was used with path: 'users' then decodedBody would be:

{
    count: 10,
    results: [...]
}
requestDetails.queryRecord

Any query string parameters

requestDetails.responseResponse

The Response object, if available

*requestDetails.urlstring

Resolved URL

requestDetails.urlArgsRecord

Any arguments used to resolve URL

Returns

One of the following:

Record

OR

false

Properties

currentState: PaginatorState

cursor: string|null

The current cursor. Only valid if inferred paginator is CursorPaginator.

internalState: Record

limit: number|null

The current limit. Only valid if inferred paginator is LimitOffsetPaginator.

nextCursor: string|null

The next cursor. Only valid if inferred paginator is CursorPaginator.

offset: number|null

The current offset. Only valid if inferred paginator is LimitOffsetPaginator.

page: number|null

The current page number. Only valid if inferred paginator is PageNumberPaginator.

pageSize: number|null

The current page size. Only valid if inferred paginator is PageNumberPaginator.

paginator: undefined|CursorPaginator|PageNumberPaginator|LimitOffsetPaginator

The underlying inferred paginator instance (if known). Only available after setResponse has been called.

previousCursor: string|null

The previous cursor. Only valid if inferred paginator is CursorPaginator.

responseIsSet: boolean

setCurrentState:
Function

setInternalState:
Function

total: number|null

The total number of records available. Not valid if inferred paginator is CursorPaginator.

totalPages: number|null

The total number of records available. Only valid if inferred paginator is PageNumberPaginator.