booleanParam

src/params/boolean-param.tsfunction

booleanParam()

booleanParam(key: string, options: BooleanParamOptions & object): ListParam<boolean>

A param holding a flag — “show archived”.

Reads true or 1 as true, false or 0 as false; anything else, or a key given twice, falls back to the default. Writes 'true' or 'false'.

Parameter	Type	Description
key	string	The page-URL key
options	BooleanParamOptions & object	The default

Returns — The param