File: /var/www/vhost/disk-apps/pwa.sports-crowd.com/node_modules/@capgo/nativegeocoder/dist/docs.json
{
"api": {
"name": "NativeGeocoderPlugin",
"slug": "nativegeocoderplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "reverseGeocode",
"signature": "(options: ReverseOptions) => any",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ReverseOptions"
}
],
"returns": "any",
"tags": [
{
"name": "param",
"text": "id The bundle id to delete (note, this is the bundle id, NOT the version name)"
},
{
"name": "returns",
"text": "an Promise with the list of addresses according to maxResults"
},
{
"name": "throws",
"text": "An error if the something went wrong"
},
{
"name": "since",
"text": "0.0.1"
}
],
"docs": "Convert latitude and longitude to an address",
"complexTypes": [
"ReverseOptions",
"Address"
],
"slug": "reversegeocode"
},
{
"name": "forwardGeocode",
"signature": "(options: ForwardOptions) => any",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ForwardOptions"
}
],
"returns": "any",
"tags": [
{
"name": "returns",
"text": "an Promise with the list of addresses according to maxResults"
},
{
"name": "throws",
"text": "An error if the something went wrong"
},
{
"name": "since",
"text": "0.0.1"
}
],
"docs": "Convert an address to latitude and longitude",
"complexTypes": [
"ForwardOptions",
"Address"
],
"slug": "forwardgeocode"
}
],
"properties": []
},
"interfaces": [
{
"name": "ReverseOptions",
"slug": "reverseoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "latitude",
"tags": [],
"docs": "latitude is a number representing the latitude of the location.",
"complexTypes": [],
"type": "number"
},
{
"name": "longitude",
"tags": [],
"docs": "longitude is a number representing the longitude of the location.",
"complexTypes": [],
"type": "number"
},
{
"name": "useLocale",
"tags": [],
"docs": "Localise the results to the given locale.",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "defaultLocale",
"tags": [],
"docs": "locale is a string in the format of language_country, for example en_US.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "maxResults",
"tags": [],
"docs": "Max number of results to return.",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "apiKey",
"tags": [],
"docs": "Only used for web platform to use google api",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "resultType",
"tags": [],
"docs": "Only used for web platform to use google api",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "Address",
"slug": "address",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "latitude",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "longitude",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "countryCode",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "countryName",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "postalCode",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "administrativeArea",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "subAdministrativeArea",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "locality",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "subLocality",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "thoroughfare",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "subThoroughfare",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "areasOfInterest",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "{}"
}
]
},
{
"name": "ForwardOptions",
"slug": "forwardoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "addressString",
"tags": [],
"docs": "address is a string of the address to be geocoded.",
"complexTypes": [],
"type": "string"
},
{
"name": "useLocale",
"tags": [],
"docs": "Localise the results to the given locale.",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "defaultLocale",
"tags": [],
"docs": "locale is a string in the format of language_country, for example en_US.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "maxResults",
"tags": [],
"docs": "Max number of results to return.",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "apiKey",
"tags": [],
"docs": "Only used for web platform to use google api",
"complexTypes": [],
"type": "string | undefined"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}