chore(api/geolocation): fix docs

socketsupply · Oct 3, 2023 · 59a7591 · 59a7591
1 parent 77622de
commit 59a7591
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/api/index.d.ts b/api/index.d.ts
@@ -6072,21 +6072,19 @@ declare module "socket:internal/geolocation" {
     /**
      * @param {function(GeolocationPosition)} onSuccess
      * @param {onError(Error)} onError
-     * @param {?({ timeout?: number })} [options]
+     * @param {object=} options
+     * @param {number=} options.timeout
      * @return {Promise}
      */
-    export function getCurrentPosition(onSuccess: (arg0: GeolocationPosition) => any, onError: any, options?: ({
-        timeout?: number;
-    }) | null, ...args: any[]): Promise<any>;
+    export function getCurrentPosition(onSuccess: (arg0: GeolocationPosition) => any, onError: any, options?: object | undefined, ...args: any[]): Promise<any>;
     /**
      * @param {function(GeolocationPosition)} onSuccess
      * @param {function(Error)} onError
-     * @param {?({ timeout?: number })} [options]
+     * @param {object=} options
+     * @param {number=} options.timeout
      * @return {Promise}
      */
-    export function watchPosition(onSuccess: (arg0: GeolocationPosition) => any, onError: (arg0: Error) => any, options?: ({
-        timeout?: number;
-    }) | null, ...args: any[]): Promise<any>;
+    export function watchPosition(onSuccess: (arg0: GeolocationPosition) => any, onError: (arg0: Error) => any, options?: object | undefined, ...args: any[]): Promise<any>;
     export function clearWatch(id: any, ...args: any[]): any;
     export namespace platform {
         let getCurrentPosition: Function;

diff --git a/api/internal/geolocation.js b/api/internal/geolocation.js
@@ -127,7 +127,8 @@ export const platform = {
 /**
  * @param {function(GeolocationPosition)} onSuccess
  * @param {onError(Error)} onError
- * @param {?({ timeout?: number })} [options]
+ * @param {object=} options
+ * @param {number=} options.timeout
  * @return {Promise}
  */
 export async function getCurrentPosition (
@@ -212,7 +213,8 @@ export async function getCurrentPosition (
 /**
  * @param {function(GeolocationPosition)} onSuccess
  * @param {function(Error)} onError
- * @param {?({ timeout?: number })} [options]
+ * @param {object=} options
+ * @param {number=} options.timeout
  * @return {Promise}
  */
 export function watchPosition (