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": "checkAndRequestPermissions",
        "signature": "() => Promise<PermissionStatus>",
        "parameters": [],
        "returns": "Promise<PermissionStatus>",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "PermissionStatus"
        ],
        "slug": "checkandrequestpermissions"
      },
      {
        "name": "configureEdgeToEdge",
        "signature": "(options: { bgColor: string; style: 'DARK' | 'LIGHT'; overlay?: boolean; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ bgColor: string; style: 'DARK' | 'LIGHT'; overlay?: boolean | undefined; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "configureedgetoedge"
      },
      {
        "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": "speed",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "acceleration",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "directionRad",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "isMocked",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "predicted",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "boolean | undefined"
        }
      ]
    },
    {
      "name": "PermissionStatus",
      "slug": "permissionstatus",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "location",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "'granted' | 'denied'"
        },
        {
          "name": "wifi",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "'granted' | 'denied'"
        }
      ]
    },
    {
      "name": "PluginListenerHandle",
      "slug": "pluginlistenerhandle",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "remove",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "() => Promise<void>"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}