Module containers/url-state

Index

Interfaces

IAppUrlState

Functions

Functions

areStatesEqual

areStatesEqual(a: IAppUrlState, b: IAppUrlState): boolean

Determines if the 2 url state are equal

since
0.14.5

Parameters
- a: IAppUrlState
- b: IAppUrlState
Returns boolean
true if both states are equal. false otherwise

getStateFromUrl

getStateFromUrl(ignoreKeys?: string[]): IAppUrlState

Gets the application state from the current main URL. If the URL was updated with custom state via updateUrl(), they will also be included in the returned state.

export
since
0.13

since
0.14 - New optional ignoreKeys to avoid reading out certain properties from URL state

Parameters
- Optional ignoreKeys: string[]
Returns IAppUrlState

updateUrl

updateUrl(state: IAppUrlState, extraState?: any, ignoreProps?: string[]): void

Updates the main URL with the given application state. If passing extra custom state, this extra custom state is also included when getStateFromUrl() is called.

Also if the custom state shares the same keys as the main application state, the application state takes precedence (ie. The key/value in the custom state will not overwrite the application state for the same key).

To avoid this, you should delete/omit said keys from the application state when calling this method if you want to take the equivalent key/value from the custom state.

export
since
0.13

since
0.14 - New optional extraState argument

since
0.14.9 - New optional ignoreProps argument

Parameters
- state: IAppUrlState
- Optional extraState: any
- Optional ignoreProps: string[]
  
  Do not write the following properties to the URL
Returns void

Generated using TypeDoc