This version of the documentation is outdated! Click here for the latest released version.

CompassError

A CompassError object is returned to the [compassError](../parameters/compassError.html) callback function when an error occurs.

Properties

code: One of the predefined error codes listed below.

Constants

CompassError.COMPASS_INTERNAL_ERR
CompassError.COMPASS_NOT_SUPPORTED

Description

When an error occurs, the CompassError object is passed as a parameter to a [compassError](../parameters/compassError.html) callback function.