integerParam

src/params/integer-param.tsfunction

integerParam()

integerParam(key: string, options: IntegerParamOptions & object): ListParam<number>

A param holding a whole number — a page, a page size, a year.

Reads one value made of an optional - and digits, within min–max and JavaScript’s safe-integer range. Anything else — 1.5, 1e3, +2, 2, a key given twice — falls back to the default.

Parameter	Type	Description
key	string	The page-URL key
options	IntegerParamOptions & object	The default and the accepted range

Returns — The param