Class UrlHash

This helper is used to set an anchor part of the url to a list of key value pairs like: #/key/value/key2/value2

Hierarchy

UrlHash

Index

Constructors

constructor

Methods

Constructors

constructor

new UrlHash(): UrlHash

Returns UrlHash

Methods

Static get

get(key: string, defaultValue?: null | string): undefined | null | string

- Defined in src/Browser/UrlHash.ts:52
Returns the value for a given key

Parameters
- key: string
  
  The key to retrieve the value for
- Optional defaultValue: null | string
  
  Optional value which is returned if the given key does not exist
Returns undefined | null | string

Static getAll

getAll(): PlainObject<any>

- Defined in src/Browser/UrlHash.ts:94
Returns all key value pairs that are currently in the hash

Returns PlainObject<any>

Static has

has(key: string): boolean

- Defined in src/Browser/UrlHash.ts:41
Checks if a given key is set in the current anchor tag

Parameters
- key: string
Returns boolean

Static Protected parseFromUrl

parseFromUrl(): PlainObject<any>

- Defined in src/Browser/UrlHash.ts:103
Parses the current hash value into an object The hash is expected to look like #/key/value/key2/value2

Returns PlainObject<any>

Static set

set(key: string, value: null | string | number): void

- Defined in src/Browser/UrlHash.ts:63
Sets a single key value pair

Parameters
- key: string
- value: null | string | number
Returns void

Static setMultiple

setMultiple(values: PlainObject<any>): void

- Defined in src/Browser/UrlHash.ts:78
Sets multiple values using only a single change request

Parameters
- values: PlainObject<any>
Returns void

Static Protected update

update(hash: PlainObject<any>): void

- Defined in src/Browser/UrlHash.ts:141
Converts the given hash object into a string representation valid for the url

Parameters
- hash: PlainObject<any>
Returns void

Generated using TypeDoc