location overview

Service to handle page’s Location.

Added in v2.0.0

---

Table of contents

• capabilities
  • LocationSvc (interface)
• instances
  • location
• model
  • Location (interface)

---

capabilities

LocationSvc (interface)

Signature

export interface LocationSvc {
  location: Location;
}

Added in v2.0.0

instances

location

Live instance of Location service.

Signature

export declare const location: () => Location;

Added in v2.0.0

model

Location (interface)

Defines the Location service capabilities.

Signature

export interface Location {
  /**
   * Gets Location data of provided Window.
   */
  data: IO<Window['location']>;

  /**
   * Reads query parameter value from url.
   */
  qp: (name: string) => string | undefined;
}

Added in v2.0.0