location.watchHeading
Calls callback as the device turns, until remove(). Rejects without a compass.
Usage
Observe compass readings and stop when the screen unmounts.
// Observe compass readings and stop when the screen unmounts.
import { Text, onMount, signal, location, type EventSubscription } from 'kuito';
export function Compass() {
const heading = signal('Waiting for compass');
onMount(() => {
let disposed = false;
let subscription: EventSubscription | undefined;
void location
.watchHeading((value) => {
heading.value = JSON.stringify(value);
})
.then((value) => {
if (disposed) value.remove();
else subscription = value;
})
.catch((error) => {
heading.value = String(error);
});
return () => {
disposed = true;
subscription?.remove();
};
});
return <Text>{heading.value}</Text>;
}Signatures
(callback: (heading: LocationHeading) => void): Promise<EventSubscription>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
callback | (heading: LocationHeading) => void | Yes | — |
Returns
Promise<EventSubscription>
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.