Class UrlService

Hierarchy

BaseService<Options>
- UrlService

Implements

Service

Index

Interfaces

Type aliases

UrlStateFunction

Constructors

constructor

Properties

Methods

Object literals

urlState

Type aliases

Static UrlStateFunction

UrlStateFunction: function

Type declaration

- (state: any): any
- Parameters
  - state: any
  Returns any

Constructors

constructor

new UrlService(app: StoreFront, opts: Options): UrlService

Overrides BaseService.constructor
- Defined in services/url.ts:23
Parameters
- app: StoreFront
- opts: Options
Returns UrlService

Properties

Protected app

app: StoreFront

beautifier

beautifier: SimpleBeautifier

Protected opts

Static getBasePath

getBasePath: getBasePath = Utils.getBasePath

Methods

buildUrlAndReplaceHistory

buildUrlAndReplaceHistory(__namedParameters: object): void

- Defined in services/url.ts:126
Parameters
- __namedParameters: object
  - route: string
  - state: State
Returns void

emitUrlUpdated

emitUrlUpdated(oldUrl: string, newUrl: string, payload: string): void

- Defined in services/url.ts:152
Parameters
- oldUrl: string
- newUrl: string
- payload: string
Returns void

filterState

filterState(state: State): object

- Defined in services/url.ts:158
Parameters
- state: State
Returns object
- session: session
- data: object
  - past: undefined[]
  - present: object
    - products: ProductWithMetadata[]

generateRoutes

generateRoutes(): any

- Defined in services/url.ts:84
Returns any

handleCurrentLocation

handleCurrentLocation(): Promise<void>

- Defined in services/url.ts:48
Returns Promise<void>

handleUrl

handleUrl(): void

- Defined in services/url.ts:40
Returns void

init

init(): void

Overrides BaseService.init
- Defined in services/url.ts:35
Returns void

listenForHistoryChange

listenForHistoryChange(): void

- Defined in services/url.ts:94
Returns void

refreshState

refreshState(state: any): Promise<any>

- Defined in services/url.ts:184
Parameters
- state: any
Returns Promise<any>

replaceHistory

replaceHistory(url: string): void

- Defined in services/url.ts:131
Parameters
- url: string
Returns void

rewind

rewind(event: PopStateEvent): void

- Defined in services/url.ts:173
Parameters
- event: PopStateEvent
Returns void

triggerRequest

triggerRequest(route: string, urlState: SearchUrlState | DetailsUrlState): void

- Defined in services/url.ts:60
Parameters
- route: string
- urlState: SearchUrlState | DetailsUrlState
Returns void

updateHistory

updateHistory(__namedParameters: object): void

- Defined in services/url.ts:99
Parameters
- __namedParameters: object
  - route: string
  - state: State
Returns void

Object literals

urlState

urlState: object

details

details: detailsUrlState = Utils.detailsUrlState

navigation

navigation: navigationUrlState = Utils.navigationUrlState

pastpurchase

pastpurchase: pastPurchaseUrlState = Utils.pastPurchaseUrlState

search

search: searchUrlState = Utils.searchUrlState

Generated using TypeDoc