Interface Module

The skeleton of the RNLocation class.

interface Module {
    configure: (options?: ConfigureOptions) => void;
    configureWithRestart: (options?: ConfigureOptions) => void;
    getCurrent: (options?: CurrentOptions) => Promise<Location>;
    manager: Manager;
    permission: Permission;
    subscribe: () => Subscription;
    unsubscribe: (id: string) => void;
}

Properties

configure: (options?: ConfigureOptions) => void

Configures settings for location tracking that will be used when subscribing to location updates.

configureWithRestart: (options?: ConfigureOptions) => void

Apply configure and reboot to force the new options.

getCurrent: (options?: CurrentOptions) => Promise<Location>

Gets the current location of the user.

manager: Manager

Helper class that manages GPS-related operations.

permission: Permission

Helper class that manages permission-related operations.

subscribe: () => Subscription

Subscribes to location updates.

unsubscribe: (id: string) => void

Unsubscribes from a previously registered location subscription.