#useGeolocation

const geo = useGeolocation(options)

/**
 * DOM 内置的地理位置 API 选项
 *
 * @see https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/getCurrentPosition#options
 */
interface PositionOptions {
  enableHighAccuracy?: boolean  // 是否启用高精度
  maximumAge?: number  // 位置信息的最大缓存时间
  timeout?: number  // 获取位置信息的超时时间
}

export type UseGeolocationOptions = PositionOptions & {
  /**
   * 是否立即开始观察地理位置。
   *
   * @defaultValue true
   */
  immediate?: boolean
}

export type UseGeolocationReturns = Pausable & {
  /**
   * 是否支持地理位置 API。
   */
  isSupported: boolean
  /**
   * 当前的纬度。
   */
  latitude: number | null
  /**
   * 当前的经度。
   */
  longitude: number | null
  /**
   * 当前地理位置状态。
   */
  isLocating: boolean
  /**
   * 地理位置最后更新的时间戳。
   */
  locatedAt: number | null
  /**
   * 若有的话，错误对象。
   */
  error: GeolocationPositionError | null
  /**
   * 当前地理位置坐标。
   */
  coords: Omit<GeolocationPosition['coords'], 'latitude' | 'longitude'> & {
    latitude: number | null
    longitude: number | null
  }
}