Skip to main content
zerotal

Documentation


Documentation / @zerotal/core / index / currentPage

Function: currentPage()

currentPage(pageName?): number

Defined in: pipeline/currentPage.ts:39

The page a paginator should return, for the request in flight.

Order: a resolver registered for this request, then the query string, then 1. Outside a request — a queue worker, a CLI command, a test — there is nothing to read, so it is 1.

Parameters

pageName?

string = "page"

The paginator's name. Defaults to "page".

Returns

number

A 1-based page number, never below 1.