Usage

Request a current position

tsx
import { Text, location, permissions } from 'kuito';

const { status } = await permissions.request('location');

if (status === 'granted') {
  const here = await location.current({ accuracy: 'high' });
  const [place] = await location.reverseGeocode(here.coords);
}

function Here() {
  // Locates while Here is mounted; the fixes land in location.position.
  location.watch({ distanceInterval: 20 });

  return <Text>{`${location.position.value?.coords.latitude ?? '…'}`}</Text>;
}

Properties and methods 1

NameTypeRequiredDescription
valuereadonlyLocationObjectYes—
value — nested fields

value fields

NameTypeRequiredDescription
coordsLocationCoordsYes—
timestampnumberYesMilliseconds since the epoch, when the fix was taken.
mockedbooleanYesThe fix came from the iOS simulator or an Android mock-location app.
coords — nested fields

coords fields

NameTypeRequiredDescription
latitudenumberYes—
longitudenumberYes—
altitudenumberYesAbove sea level (iOS), or the WGS 84 ellipsoid (Android).
accuracynumberYesThe radius of 68% confidence around the position.
altitudeAccuracynumberYes—
headingnumberYesDegrees clockwise from true north that the device is moving.
speednumberYesMeters per second.
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.