Interface LocationServices

A virtual location services API that fake Geolocation APIs can use to acquire the coordinates, and subscribe changes in the coordinates.

interface LocationServices {
    acquireCoordinates: (
        enableHighAccuracy: boolean,
    ) => Promise<GeolocationCoordinates>;
    isEnabled: boolean;
    subscribe: (subscriber: LocationServicesSubscriber) => () => void;
}

Hierarchy (View Summary)

LocationServices
- MutableLocationServices

Index

Properties

acquireCoordinates isEnabled subscribe

Properties

acquireCoordinates

acquireCoordinates: (
enableHighAccuracy: boolean,
) => Promise<GeolocationCoordinates>

Acquire the coordinates.

Type declaration

- (enableHighAccuracy: boolean): Promise<GeolocationCoordinates>
- Parameters
  - enableHighAccuracy: boolean
    Whether to acquire high accuracy coordinates.
  Returns Promise<GeolocationCoordinates>
  The coordinates.

Throws

An Error if the location services are disabled, or if the coordinates are unavailable.

`Readonly`isEnabled

isEnabled: boolean

Whether the location services are enabled.

subscribe: (subscriber: LocationServicesSubscriber) => () => void

Subscribe to changes in the coordinates.

Type declaration

- (subscriber: LocationServicesSubscriber): () => void
- Parameters
  - subscriber: LocationServicesSubscriber
    A subscriber function that will be called when the coordinates change.
  Returns () => void
  A function to unsubscribe the subscriber.