dumon-geolocation/dist/docs.json

{
  "api": {
    "name": "DumonGeolocationPlugin",
    "slug": "dumongeolocationplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "startPositioning",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "startpositioning"
      },
      {
        "name": "stopPositioning",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "stoppositioning"
      },
      {
        "name": "getLatestPosition",
        "signature": "() => Promise<PositioningData>",
        "parameters": [],
        "returns": "Promise<PositioningData>",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "PositioningData"
        ],
        "slug": "getlatestposition"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'onPositionUpdate', listenerFunc: (data: PositioningData) => void) => PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'onPositionUpdate'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "(data: PositioningData) => void"
          }
        ],
        "returns": "PluginListenerHandle",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "PluginListenerHandle",
          "PositioningData"
        ],
        "slug": "addlisteneronpositionupdate-"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "PositioningData",
      "slug": "positioningdata",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "source",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "'GNSS' | 'WIFI' | 'FUSED' | 'MOCK'"
        },
        {
          "name": "timestamp",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "latitude",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "longitude",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "accuracy",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "gnssData",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "SatelliteStatus"
          ],
          "type": "SatelliteStatus"
        },
        {
          "name": "wifiData",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "WifiAp"
          ],
          "type": "WifiAp[] | undefined"
        },
        {
          "name": "imuData",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "ImuData"
          ],
          "type": "ImuData"
        }
      ]
    },
    {
      "name": "SatelliteStatus",
      "slug": "satellitestatus",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "satellitesInView",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "usedInFix",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "constellationCounts",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "{ [key: string]: number; }"
        }
      ]
    },
    {
      "name": "WifiAp",
      "slug": "wifiap",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "ssid",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "bssid",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "rssi",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "distance",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number | undefined"
        }
      ]
    },
    {
      "name": "ImuData",
      "slug": "imudata",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "accelX",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "accelY",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "accelZ",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "gyroX",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "gyroY",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "gyroZ",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "speed",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "acceleration",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "directionRad",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number | undefined"
        }
      ]
    },
    {
      "name": "PluginListenerHandle",
      "slug": "pluginlistenerhandle",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "remove",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "() => Promise<void>"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}