location.LocationTaskOptions — Kuito Documentation

Usage

Register background updates

This type is used by location.startUpdates

tsx

import { location, permissions, storage } from 'kuito';

// At module scope: a background launch runs the app's modules, not its UI.
location.defineUpdates('run', async ({ locations }) => {
  const track: unknown[] = JSON.parse((await storage.get('track')) ?? '[]');

  await storage.set('track', JSON.stringify([...track, ...locations.map((fix) => fix.coords)]));
});

async function startRun() {
  const { status } = await permissions.request('locationAlways');

  if (status === 'granted')
    await location.startUpdates('run', {
      accuracy: 'high',
      distanceInterval: 10,
      notification: { title: 'Recording your run' },
    });
}

Type declaration

export type LocationTaskOptions = WatchPositionOptions & {
  /** iOS: let Core Location pause updates while the device stays put. Off by default. */
  pausesUpdatesAutomatically?: boolean;
  /** iOS: the blue status bar pill while the app locates in the background. Off by default. */
  showsBackgroundLocationIndicator?: boolean;
  /** Android: the foreground service's notification. Defaults to the app's name. */
  notification?: { title?: string; body?: string };
};

Members 6

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.
`pausesUpdatesAutomatically`	`boolean`	No	iOS: let Core Location pause updates while the device stays put. Off by default.
`showsBackgroundLocationIndicator`	`boolean`	No	iOS: the blue status bar pill while the app locates in the background. Off by default.
`notification`	`{ title?: string; body?: string;}`	No	Android: the foreground service's notification. Defaults to the app's name.

notification — nested fields

notification fields

Name	Type	Required	Description
`title`	`string`	No	—
`body`	`string`	No	—

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