WatchPositionOptions — Kuito Documentation

Usage

Request a current position

This type is used by location.watch

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>;
}

Type declaration

export type WatchPositionOptions = LocationOptions & {
  /** Milliseconds between updates, at least. Android only; iOS delivers as fixes come. */
  timeInterval?: number;
  /** Meters the device moves before the next update. */
  distanceInterval?: number;
};

Members 3

Name	Type	Required	Description
`accuracy`	`Accuracy`	No	—
`timeInterval`	`number`	No	Milliseconds between updates, at least. Android only; iOS delivers as fixes come.
`distanceInterval`	`number`	No	Meters the device moves before the next update.

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.