feat: support options for useGeolocation

streamich · Apr 23, 2019 · 7d4c59e · 7d4c59e
2 parents 9e8873e + 01959a1
commit 7d4c59e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/docs/useGeolocation.md b/docs/useGeolocation.md
@@ -1,7 +1,6 @@
 # `useGeolocation`
 
-React sensor hook that tracks user's geographic location.
-
+React sensor hook that tracks user's geographic location. This hook accepts [position options](https://developer.mozilla.org/docs/Web/API/PositionOptions).
 
 ## Usage
 
@@ -18,3 +17,9 @@ const Demo = () => {
   );
 };
 ```
+
+## Reference
+
+```ts
+useGeolocation(options: PositionOptions)
+```
diff --git a/src/useGeolocation.ts b/src/useGeolocation.ts
@@ -13,7 +13,7 @@ export interface GeoLocationSensorState {
   error?: Error | PositionError;
 }
 
-const useGeolocation = (): GeoLocationSensorState => {
+const useGeolocation = (options?: PositionOptions): GeoLocationSensorState => {
   const [state, setState] = useState<GeoLocationSensorState>({
     loading: true,
     accuracy: null,
@@ -47,8 +47,8 @@ const useGeolocation = (): GeoLocationSensorState => {
     mounted && setState(oldState => ({ ...oldState, loading: false, error }));
 
   useEffect(() => {
-    navigator.geolocation.getCurrentPosition(onEvent, onEventError);
-    watchId = navigator.geolocation.watchPosition(onEvent, onEventError);
+    navigator.geolocation.getCurrentPosition(onEvent, onEventError, options);
+    watchId = navigator.geolocation.watchPosition(onEvent, onEventError, options);
 
     return () => {
       mounted = false;