@nw01/rayneo-geolocation

Geolocation capabilities plugin

Install

npm install @nw01/rayneo-geolocation
npx cap sync

API

• getCurrentPosition(...)
• watchPosition(...)
• clearWatch(...)
• checkPermissions()
• requestPermissions()
• Interfaces

getCurrentPosition(...)

getCurrentPosition(options?: GeolocationOptions | undefined) => Promise<GeolocationPosition>

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | GeolocationOptions |

Returns: Promise<GeolocationPosition>

watchPosition(...)

watchPosition(options: GeolocationOptions, callback: (position: GeolocationPosition, err?: any) => void) => Promise<PluginListenerHandle>

| Param | Type | | -------------- | ----------------------------------------------------------------------------------------------------- | | options | GeolocationOptions | | callback | (position: GeolocationPosition, err?: any) => void |

Returns: Promise<PluginListenerHandle>

clearWatch(...)

clearWatch(options: CallbackId) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | CallbackId |

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

Interfaces

GeolocationPosition

| Prop | Type | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | coords | { latitude: number; longitude: number; accuracy: number; altitude?: number | null; altitudeAccuracy?: number | null; heading?: number | null; speed?: number | null; } | | timestamp | number |

GeolocationOptions

| Prop | Type | | --------------------------- | -------------------- | | enableHighAccuracy | boolean | | timeout | number | | maximumAge | number | | minimumUpdateInterval | number |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

CallbackId

| Prop | Type | | -------- | ------------------- | | id | string |

PermissionStatus

| Prop | Type | | -------------------- | ---------------------------------------------- | | location | 'granted' | 'denied' | 'prompt' | | coarseLocation | 'granted' | 'denied' | 'prompt' |