Class: PageParam ‹V›#
Type parameters#
▪ V
Hierarchy#
- PageParam
Index#
Constructors#
Properties#
Accessors#
Methods#
Constructors#
constructor#
+ new PageParam(init: PageParamInit‹V›, history: ObservableHistory): PageParam
Defined in src/renderer/navigation/page-param.ts:37
Parameters:
| Name | Type |
|---|---|
init |
PageParamInit‹V› |
history |
ObservableHistory |
Returns: PageParam
Properties#
isMulti#
• isMulti: boolean
Defined in src/renderer/navigation/page-param.ts:37
name#
• name: string
Defined in src/renderer/navigation/page-param.ts:36
Accessors#
defaultValue#
• get defaultValue(): V | undefined
Defined in src/renderer/navigation/page-param.ts:48
Returns: V | undefined
Methods#
clear#
▸ clear(): void
Defined in src/renderer/navigation/page-param.ts:112
Returns: void
get#
▸ get(): V
Defined in src/renderer/navigation/page-param.ts:73
Returns: V
getRaw#
▸ getRaw(): string | string[]
Defined in src/renderer/navigation/page-param.ts:105
Get stringified raw value(s) from document.location.search
Returns: string | string[]
parse#
▸ parse(values: string | string[]): V
Defined in src/renderer/navigation/page-param.ts:52
Parameters:
| Name | Type |
|---|---|
values |
string | string[] |
Returns: V
set#
▸ set(value: V, __namedParameters: object): void
Defined in src/renderer/navigation/page-param.ts:78
Parameters:
▪ value: V
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
mergeGlobals |
boolean | true |
replaceHistory |
boolean | false |
Returns: void
setRaw#
▸ setRaw(value: string | string[]): void
Defined in src/renderer/navigation/page-param.ts:89
Set stringified raw value(s) and update document.location.search
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | string[] |
Returns: void
stringify#
▸ stringify(value: V): string[]
Defined in src/renderer/navigation/page-param.ts:63
Parameters:
| Name | Type | Default |
|---|---|---|
value |
V | this.get() |
Returns: string[]
toString#
▸ toString(__namedParameters: object): string
Defined in src/renderer/navigation/page-param.ts:116
Parameters:
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
mergeGlobals |
boolean | true |
value |
V | this.get() |
withPrefix |
boolean | true |
Returns: string