Class GeoXpWebGeolocation

GeoXpWebGeolocation provides use location informations based on navigator.geolocation api

Index

Constructors

Methods

getLocation off on once reload toggleUpdates unload unlock

Constructors

constructor

new GeoXpWebGeolocation(
geoXpCore: GeoXpCore,
config?: GeoXpWebGeolocationConfig,
): GeoXpWebGeolocation
Constructor for GeoXpWebGeolocation Class
Parameters
- geoXpCore: GeoXpCore
  GeoXpCore instance reference
- Optionalconfig: GeoXpWebGeolocationConfig
  GeoXpWebGeolocation configuration
Returns GeoXpWebGeolocation
GeoXpWebGeolocation singleton instance
- Defined in web-geolocation/index.ts:60

Methods

getLocation

getLocation(): undefined | GeoXpGeolocation
Get current (last) location

Returns undefined | GeoXpGeolocation
current (last) location
- Defined in web-geolocation/index.ts:139

off

off<K>(
    eventName: "location" | K,
    listener: K extends "location"
        ? GeoXpWebGeolocationEvent[K<K>] extends unknown[]
            ? (...args: GeoXpWebGeolocationEvent[K<K>]) => void
            : never
        : never,
): void
Event wrapper off
Type Parameters
- K
Parameters
- eventName: "location" | K
  'location'
- listener: K extends "location"
      ? GeoXpWebGeolocationEvent[K<K>] extends unknown[]
          ? (...args: GeoXpWebGeolocationEvent[K<K>]) => void
          : never
      : never
  event listener
Returns void
- Defined in web-geolocation/index.ts:242

on

on<K>(
    eventName: "location" | K,
    listener: K extends "location"
        ? GeoXpWebGeolocationEvent[K<K>] extends unknown[]
            ? (...args: GeoXpWebGeolocationEvent[K<K>]) => void
            : never
        : never,
): void
Event wrapper on
Type Parameters
- K
Parameters
- eventName: "location" | K
  'location'
- listener: K extends "location"
      ? GeoXpWebGeolocationEvent[K<K>] extends unknown[]
          ? (...args: GeoXpWebGeolocationEvent[K<K>]) => void
          : never
      : never
  event listener
Returns void
- Defined in web-geolocation/index.ts:211

once

once<K>(
    eventName: "location" | K,
    listener: K extends "location"
        ? GeoXpWebGeolocationEvent[K<K>] extends unknown[]
            ? (...args: GeoXpWebGeolocationEvent[K<K>]) => void
            : never
        : never,
): void
Event wrapper once
Type Parameters
- K
Parameters
- eventName: "location" | K
  'location'
- listener: K extends "location"
      ? GeoXpWebGeolocationEvent[K<K>] extends unknown[]
          ? (...args: GeoXpWebGeolocationEvent[K<K>]) => void
          : never
      : never
  event listener
Returns void
- Defined in web-geolocation/index.ts:225

reload

reload(config: GeoXpWebGeolocationConfig): void
Loads a new configuration
Parameters
- config: GeoXpWebGeolocationConfig
  Config options
Returns void
- Defined in web-geolocation/index.ts:115

toggleUpdates

toggleUpdates(enabled: boolean): void
Enables / disables geolocation updates
Parameters
- enabled: boolean
  enabled or disabled
Returns void
- Defined in web-geolocation/index.ts:147

unload

unload(): void
Unloads all subscriptions

Returns void
- Defined in web-geolocation/index.ts:124

unlock

unlock(): void
Unlocks geolocation API

Returns void
- Defined in web-geolocation/index.ts:131