ClassGeolocationPositionProvider

A position provider that uses the browser's Geolocation API to provide the user's current location.

Implements

PositionProvider

Index

Constructors

Accessors

currentPosition

Methods

subscribeToPosition

Constructors

constructor

new GeolocationPositionProvider(options?): GeolocationPositionProvider
Creates a new geolocation position provider.
Parameters
- options: PositionOptions = ...
  Options for the geolocation API. Defaults to high accuracy with a 10-second timeout.
Returns GeolocationPositionProvider

Accessors

currentPosition

get currentPosition(): null | Position
The current position from the geolocation API.

Returns null | Position
Implementation of PositionProvider.currentPosition

Methods

subscribeToPosition

subscribeToPosition(callback): (() => void)
Subscribes to position updates from the geolocation API.
Parameters
- callback: ((position: null | Position) => void)
  The callback to call when the position changes.
  - - (position): void
    - Parameters
      position: null | Position
      Returns void
Returns (() => void)
A function to unsubscribe from the position updates.
- - (): void
  - Returns void
Implementation of PositionProvider.subscribeToPosition