rooks
Version:
Collection of awesome react hooks
14 lines (13 loc) • 477 B
TypeScript
import { UseGeolocationReturnType } from "../types/types";
type UseGeoLocationOptions = PositionOptions & {
when?: boolean;
};
/**
* useGeolocation
* Gets the geolocation data as a hook
*
* @param {UseGeoLocationOptions} geoLocationOptions Geolocation options
* @see {@link https://rooks.vercel.app/docs/hooks/useGeolocation}
*/
declare const useGeolocation: (geoLocationOptions?: UseGeoLocationOptions) => UseGeolocationReturnType | null;
export { useGeolocation };