mini-types/types/api/device/compass.d.ts

TypeScript declarations for Alipay's mini program.

/**
 * @file 罗盘
 */
declare namespace my {
  interface IOnCompassChangeEvent {
    /**
     * 面对的方向与正北方向的度数[0,360)
     */
    readonly direction: number;
  }

  /**
   * 监听罗盘数据，接口调用后会自动开始监听，回调间隔为500ms，可使用my.offCompassChange停止监听。
   */
  function onCompassChange(cb: (res: IOnCompassChangeEvent) => void): void;

  /**
   * 停止监听罗盘数据。
   */
  function offCompassChange(callback?: (res: IOnCompassChangeEvent) => void): void;
}