Class: PageParam<Value>#
Renderer.Navigation.PageParam
Type parameters#
| Name | Type |
|---|---|
Value |
any |
Table of contents#
Constructors#
Properties#
Accessors#
Methods#
Constructors#
constructor#
• new PageParam<Value>(dependencies, init)
Type parameters#
| Name | Type |
|---|---|
Value |
any |
Parameters#
| Name | Type |
|---|---|
dependencies |
PageParamDependencies |
init |
PageParamInit<Value> |
Properties#
dependencies#
• Protected Readonly dependencies: PageParamDependencies
isMulti#
• Readonly isMulti: boolean
name#
• Readonly name: string
Accessors#
defaultValue#
• get defaultValue(): undefined | Value
Returns#
undefined | Value
Methods#
clear#
▸ clear(): void
Returns#
void
get#
▸ get(): Value
Returns#
Value
getRaw#
▸ getRaw(): string | string[]
Get stringified raw value(s) from document.location.search
Returns#
string | string[]
parse#
▸ parse(values): Value
Parameters#
| Name | Type |
|---|---|
values |
string | string[] |
Returns#
Value
set#
▸ set(value, __namedParameters?): void
Parameters#
| Name | Type |
|---|---|
value |
Value |
__namedParameters |
Object |
__namedParameters.mergeGlobals |
undefined | boolean |
__namedParameters.replaceHistory |
undefined | boolean |
Returns#
void
setRaw#
▸ setRaw(value): void
Set stringified raw value(s) and update document.location.search
Parameters#
| Name | Type |
|---|---|
value |
string | string[] |
Returns#
void
stringify#
▸ stringify(value?): string[]
Parameters#
| Name | Type |
|---|---|
value |
Value |
Returns#
string[]
toString#
▸ toString(__namedParameters?): string
Parameters#
| Name | Type |
|---|---|
__namedParameters |
Object |
__namedParameters.mergeGlobals |
undefined | boolean |
__namedParameters.value |
undefined | Value |
Returns#
string