Skip to main content
Version: 3.x

Taro.startCompass(option)

Starts listening on compass data.

Reference

Type

(option?: Option) => Promise<CallbackResult>

Parameters

Option

PropertyTypeRequiredDescription
complete(res: any) => voidNoThe callback function used when the API call completed (always executed whether the call succeeds or fails)
fail(res: any) => voidNoThe callback function for a failed API call
success(res: Result) => voidNoThe callback function for a successful API call

Sample Code

Taro.startCompass()

API Support

APIWeChat Mini-ProgramH5React Native
Taro.startCompass✔️✔️