@gabriel-sisjr/react-native-background-location/lib/typescript/src/NativeBackgroundLocation.d.ts

React Native library for background location tracking using TurboModules. Track user location even when the app is minimized or in the background.

import { type TurboModule } from 'react-native';
import type { Coords, TrackingStatus, LocationUpdateEvent, TrackingOptions } from './types';
export type { Coords, TrackingStatus, LocationUpdateEvent, TrackingOptions };
/**
 * Tracking options interface for TurboModule spec
 * Must be defined inline for Codegen compatibility
 */
export interface TrackingOptionsSpec {
    updateInterval?: number;
    fastestInterval?: number;
    maxWaitTime?: number;
    accuracy?: string;
    waitForAccurateLocation?: boolean;
    notificationTitle?: string;
    notificationText?: string;
    notificationChannelName?: string;
    notificationPriority?: string;
}
export interface Spec extends TurboModule {
    /**
     * Starts location tracking in background for a specific trip
     * @param tripId Optional trip identifier. If omitted, a new one will be generated
     * @param options Optional tracking configuration options
     * @returns The effective tripId (received or generated)
     */
    startTracking(tripId?: string, options?: TrackingOptionsSpec): Promise<string>;
    /**
     * Stops all location tracking and terminates the background service
     */
    stopTracking(): Promise<void>;
    /**
     * Checks if location tracking is currently active
     * @returns Object with active status and current tripId if tracking
     */
    isTracking(): Promise<TrackingStatus>;
    /**
     * Retrieves all stored location points for a specific trip
     * @param tripId The trip identifier
     * @returns Array of location coordinates
     */
    getLocations(tripId: string): Promise<Coords[]>;
    /**
     * Clears all stored location data for a specific trip
     * @param tripId The trip identifier to clear
     */
    clearTrip(tripId: string): Promise<void>;
}
declare const _default: Spec;
export default _default;
//# sourceMappingURL=NativeBackgroundLocation.d.ts.map