Class GeolocationPositionProvider

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?: PositionOptions,
): 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(): Position | null
The current position from the geolocation API.

Returns Position | null
Implementation of PositionProvider.currentPosition

Methods

subscribeToPosition

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

Implementation of PositionProvider.subscribeToPosition