Module `Brr_io.Geolocation`

Access to device location.

module Error : sig ... end

Position errors.

module Pos : sig ... end

Positions.

type opts

The type for geolocalisation options.

val opts : 
  ?high_accuracy:bool ->
  ?timeout_ms:int ->
  ?maximum_age_ms:int ->
  unit ->
  Brr_io.Geolocation.opts

opts ~high_accuracy ~maximum_age_ms ~timeout_ms () are geolocalisation options.

Geolocalizing

type t

The type for device Geolocation objects.

val of_navigator : Brr.Navigator.t -> Brr_io.Geolocation.t

of_navigator n is a device geolocalisation object for navigator n.

val get : 
  ?opts:Brr_io.Geolocation.opts ->
  Brr_io.Geolocation.t ->
  (Brr_io.Geolocation.Pos.t, Brr_io.Geolocation.Error.t) Fut.result

get l ~opts is the position of l determined with options opts.

type watch_id = int

The type for watcher identifiers.

val watch : 
  ?opts:Brr_io.Geolocation.opts ->
  Brr_io.Geolocation.t ->
  ((Brr_io.Geolocation.Pos.t, Brr_io.Geolocation.Error.t) Stdlib.result ->
    unit) ->
  Brr_io.Geolocation.watch_id

watch l ~opts f monitors the position of l determined with opts by periodically calling f. Stop watching by calling unwatch with the returned identifier.

val unwatch : Brr_io.Geolocation.t -> Brr_io.Geolocation.watch_id -> unit

unwatch l id unwatches id as returned by a previous call to watch.

val to_jv : Brr_io.Geolocation.t -> Jv.jv

val of_jv : Jv.jv -> Brr_io.Geolocation.t

Module Brr_io.Geolocation

Geolocalizing

Module `Brr_io.Geolocation`