import type { Pausable } from "../use-pausable/index.js"; export interface UseGeolocationOptions extends PositionOptions { /** * Whether to start watching the geolocation immediately. * * @defaultValue true */ immediate?: boolean; } export interface UseGeolocationReturns extends Pausable { /** * Whether the geolocation API is supported. */ isSupported: boolean; /** * The current latitude. */ latitude: number | null; /** * The current longitude. */ longitude: number | null; /** * The current geolocation state. */ isLocating: boolean; /** * The timestamp when the geolocation was last updated. */ locatedAt: number | null; /** * The error object if any. */ error: GeolocationPositionError | null; /** * The current geolocation coordinates. */ coords: Omit & { latitude: number | null; longitude: number | null; }; } /** * A React Hook that provides a simple way to get the user's [geolocation](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation). */ export declare function useGeolocation(options?: UseGeolocationOptions): UseGeolocationReturns;