offCompassChange(listener: Function)

Requires:
BaseKit≥2.3.2@ray-js/ray≥0.3.23
Platforms:
iOSAndroid
import { offCompassChange } from '@ray-js/ray';

// Promise usage
try {
  const res = await offCompassChange({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Stop listening for compass data changes; if no parameters are provided, remove all listeners

Parameters

ParameterTypeRequiredDescription
Yes

Return Value

None

Examples

import { onCompassChange, startCompass, offCompassChange } from '@ray-js/ray'

// Stop listening to compass: set up listening with onCompassChange + startCompass, then cancel with offCompassChange
onCompassChange(e => console.log(e));
startCompass({
  success: () => {},
  fail: error => console.error(error),
});
offCompassChange(
  () => console.log("Stopped listening to compass"),
  error => console.error(error)
);