GeolocationAPI

Types

geolocation

An object able to programmatically obtain the position of the device. It gives Web content access to the location of the device. This allows a Web site or app to offer customized results based on the user's location. See Geolocation on MDN

type geolocation = {}

Module

There are methods and helpers defined in Geolocation .

geolocationCoordinates

See GeolocationCoordinates on MDN

type geolocationCoordinates = {
  accuracy: float,
  latitude: float,
  longitude: float,
  altitude: Null.t<float>,
  altitudeAccuracy: Null.t<float>,
  heading: Null.t<float>,
  speed: Null.t<float>,
}

Record fields

accuracy

float

Read more on MDN

latitude

float

Read more on MDN

longitude

float

Read more on MDN

altitude

Null.t< float >

Read more on MDN

altitudeAccuracy

Null.t< float >

Read more on MDN

heading

Null.t< float >

Read more on MDN

speed

Null.t< float >

Read more on MDN

Module

There are methods and helpers defined in GeolocationCoordinates .

geolocationPosition

See GeolocationPosition on MDN

type geolocationPosition = {
  coords: geolocationCoordinates,
  timestamp: int,
}

Record fields

coords

geolocationCoordinates

Read more on MDN

timestamp

int

Read more on MDN

Module

There are methods and helpers defined in GeolocationPosition .

geolocationPositionError

See GeolocationPositionError on MDN

type geolocationPositionError = {code: int, message: string}

Record fields

code

int

Read more on MDN

message

string

Read more on MDN

positionCallback

type positionCallback = geolocationPosition => unit

positionErrorCallback

type positionErrorCallback = geolocationPositionError => unit

positionOptions

type positionOptions = {
  mutable enableHighAccuracy?: bool,
  mutable timeout?: int,
  mutable maximumAge?: int,
}

Record fields

enableHighAccuracy

option< bool >

timeout

option< int >

maximumAge

option< int >