@capgo/nativegeocoder 0.1.39 → 0.1.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +22 -22
  2. package/dist/docs.json +60 -60
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -56,7 +56,7 @@ This API requires the following permissions be added to your `AndroidManifest.xm
56
56
  ### reverseGeocode(...)
57
57
 
58
58
  ```typescript
59
- reverseGeocode(options: reverseOptions) => Promise<{ addresses: Adress[]; }>
59
+ reverseGeocode(options: reverseOptions) => any
60
60
  ```
61
61
 
62
62
  Convert latitude and longitude to an address
@@ -65,7 +65,7 @@ Convert latitude and longitude to an address
65
65
  | ------------- | --------------------------------------------------------- |
66
66
  | **`options`** | <code><a href="#reverseoptions">reverseOptions</a></code> |
67
67
 
68
- **Returns:** <code>Promise&lt;{ addresses: Adress[]; }&gt;</code>
68
+ **Returns:** <code>any</code>
69
69
 
70
70
  **Since:** 0.0.1
71
71
 
@@ -75,7 +75,7 @@ Convert latitude and longitude to an address
75
75
  ### forwardGeocode(...)
76
76
 
77
77
  ```typescript
78
- forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Adress[]; }>
78
+ forwardGeocode(options: ForwardOptions) => any
79
79
  ```
80
80
 
81
81
  Convert an address to latitude and longitude
@@ -84,7 +84,7 @@ Convert an address to latitude and longitude
84
84
  | ------------- | --------------------------------------------------------- |
85
85
  | **`options`** | <code><a href="#forwardoptions">ForwardOptions</a></code> |
86
86
 
87
- **Returns:** <code>Promise&lt;{ addresses: Adress[]; }&gt;</code>
87
+ **Returns:** <code>any</code>
88
88
 
89
89
  **Since:** 0.0.1
90
90
 
@@ -94,24 +94,6 @@ Convert an address to latitude and longitude
94
94
  ### Interfaces
95
95
 
96
96
 
97
- #### Adress
98
-
99
- | Prop | Type |
100
- | --------------------------- | --------------------- |
101
- | **`latitude`** | <code>number</code> |
102
- | **`longitude`** | <code>number</code> |
103
- | **`countryCode`** | <code>string</code> |
104
- | **`countryName`** | <code>string</code> |
105
- | **`postalCode`** | <code>string</code> |
106
- | **`administrativeArea`** | <code>string</code> |
107
- | **`subAdministrativeArea`** | <code>string</code> |
108
- | **`locality`** | <code>string</code> |
109
- | **`subLocality`** | <code>string</code> |
110
- | **`thoroughfare`** | <code>string</code> |
111
- | **`subThoroughfare`** | <code>string</code> |
112
- | **`areasOfInterest`** | <code>string[]</code> |
113
-
114
-
115
97
  #### reverseOptions
116
98
 
117
99
  | Prop | Type | Description |
@@ -124,6 +106,24 @@ Convert an address to latitude and longitude
124
106
  | **`apiKey`** | <code>string</code> | Only used for web platform to use google api |
125
107
 
126
108
 
109
+ #### Adress
110
+
111
+ | Prop | Type |
112
+ | --------------------------- | ------------------- |
113
+ | **`latitude`** | <code>number</code> |
114
+ | **`longitude`** | <code>number</code> |
115
+ | **`countryCode`** | <code>string</code> |
116
+ | **`countryName`** | <code>string</code> |
117
+ | **`postalCode`** | <code>string</code> |
118
+ | **`administrativeArea`** | <code>string</code> |
119
+ | **`subAdministrativeArea`** | <code>string</code> |
120
+ | **`locality`** | <code>string</code> |
121
+ | **`subLocality`** | <code>string</code> |
122
+ | **`thoroughfare`** | <code>string</code> |
123
+ | **`subThoroughfare`** | <code>string</code> |
124
+ | **`areasOfInterest`** | <code>{}</code> |
125
+
126
+
127
127
  #### ForwardOptions
128
128
 
129
129
  | Prop | Type | Description |
package/dist/docs.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "methods": [
8
8
  {
9
9
  "name": "reverseGeocode",
10
- "signature": "(options: reverseOptions) => Promise<{ addresses: Adress[]; }>",
10
+ "signature": "(options: reverseOptions) => any",
11
11
  "parameters": [
12
12
  {
13
13
  "name": "options",
@@ -15,7 +15,7 @@
15
15
  "type": "reverseOptions"
16
16
  }
17
17
  ],
18
- "returns": "Promise<{ addresses: Adress[]; }>",
18
+ "returns": "any",
19
19
  "tags": [
20
20
  {
21
21
  "name": "param",
@@ -36,14 +36,14 @@
36
36
  ],
37
37
  "docs": "Convert latitude and longitude to an address",
38
38
  "complexTypes": [
39
- "Adress",
40
- "reverseOptions"
39
+ "reverseOptions",
40
+ "Adress"
41
41
  ],
42
42
  "slug": "reversegeocode"
43
43
  },
44
44
  {
45
45
  "name": "forwardGeocode",
46
- "signature": "(options: ForwardOptions) => Promise<{ addresses: Adress[]; }>",
46
+ "signature": "(options: ForwardOptions) => any",
47
47
  "parameters": [
48
48
  {
49
49
  "name": "options",
@@ -51,7 +51,7 @@
51
51
  "type": "ForwardOptions"
52
52
  }
53
53
  ],
54
- "returns": "Promise<{ addresses: Adress[]; }>",
54
+ "returns": "any",
55
55
  "tags": [
56
56
  {
57
57
  "name": "returns",
@@ -68,8 +68,8 @@
68
68
  ],
69
69
  "docs": "Convert an address to latitude and longitude",
70
70
  "complexTypes": [
71
- "Adress",
72
- "ForwardOptions"
71
+ "ForwardOptions",
72
+ "Adress"
73
73
  ],
74
74
  "slug": "forwardgeocode"
75
75
  }
@@ -77,6 +77,57 @@
77
77
  "properties": []
78
78
  },
79
79
  "interfaces": [
80
+ {
81
+ "name": "reverseOptions",
82
+ "slug": "reverseoptions",
83
+ "docs": "",
84
+ "tags": [],
85
+ "methods": [],
86
+ "properties": [
87
+ {
88
+ "name": "latitude",
89
+ "tags": [],
90
+ "docs": "latitude is a number representing the latitude of the location.",
91
+ "complexTypes": [],
92
+ "type": "number"
93
+ },
94
+ {
95
+ "name": "longitude",
96
+ "tags": [],
97
+ "docs": "longitude is a number representing the longitude of the location.",
98
+ "complexTypes": [],
99
+ "type": "number"
100
+ },
101
+ {
102
+ "name": "useLocale",
103
+ "tags": [],
104
+ "docs": "Localise the results to the given locale.",
105
+ "complexTypes": [],
106
+ "type": "boolean | undefined"
107
+ },
108
+ {
109
+ "name": "defaultLocale",
110
+ "tags": [],
111
+ "docs": "locale is a string in the format of language_country, for example en_US.",
112
+ "complexTypes": [],
113
+ "type": "string | undefined"
114
+ },
115
+ {
116
+ "name": "maxResults",
117
+ "tags": [],
118
+ "docs": "Max number of results to return.",
119
+ "complexTypes": [],
120
+ "type": "number | undefined"
121
+ },
122
+ {
123
+ "name": "apiKey",
124
+ "tags": [],
125
+ "docs": "Only used for web platform to use google api",
126
+ "complexTypes": [],
127
+ "type": "string | undefined"
128
+ }
129
+ ]
130
+ },
80
131
  {
81
132
  "name": "Adress",
82
133
  "slug": "adress",
@@ -166,58 +217,7 @@
166
217
  "tags": [],
167
218
  "docs": "",
168
219
  "complexTypes": [],
169
- "type": "string[]"
170
- }
171
- ]
172
- },
173
- {
174
- "name": "reverseOptions",
175
- "slug": "reverseoptions",
176
- "docs": "",
177
- "tags": [],
178
- "methods": [],
179
- "properties": [
180
- {
181
- "name": "latitude",
182
- "tags": [],
183
- "docs": "latitude is a number representing the latitude of the location.",
184
- "complexTypes": [],
185
- "type": "number"
186
- },
187
- {
188
- "name": "longitude",
189
- "tags": [],
190
- "docs": "longitude is a number representing the longitude of the location.",
191
- "complexTypes": [],
192
- "type": "number"
193
- },
194
- {
195
- "name": "useLocale",
196
- "tags": [],
197
- "docs": "Localise the results to the given locale.",
198
- "complexTypes": [],
199
- "type": "boolean | undefined"
200
- },
201
- {
202
- "name": "defaultLocale",
203
- "tags": [],
204
- "docs": "locale is a string in the format of language_country, for example en_US.",
205
- "complexTypes": [],
206
- "type": "string | undefined"
207
- },
208
- {
209
- "name": "maxResults",
210
- "tags": [],
211
- "docs": "Max number of results to return.",
212
- "complexTypes": [],
213
- "type": "number | undefined"
214
- },
215
- {
216
- "name": "apiKey",
217
- "tags": [],
218
- "docs": "Only used for web platform to use google api",
219
- "complexTypes": [],
220
- "type": "string | undefined"
220
+ "type": "{}"
221
221
  }
222
222
  ]
223
223
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@capgo/nativegeocoder",
3
- "version": "0.1.39",
3
+ "version": "0.1.40",
4
4
  "description": "Capacitor plugin for native forward and reverse geocoding",
5
5
  "main": "dist/plugin.cjs.js",
6
6
  "module": "dist/esm/index.js",