Skip to content

Commit

Permalink
Minimal documentation for suggest feature
Browse files Browse the repository at this point in the history
See #240
  • Loading branch information
keul authored and simon04 committed Jun 4, 2019
1 parent 7542988 commit 9636bfe
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ An interface implemented to respond to geocoding queries.
| Method | Returns | Description |
| ------------------------------------- | ------------------- | ----------------- |
| `geocode(<String> query, callback, context)` | `GeocodingResult[]` | Performs a geocoding query and returns the results to the callback in the provided context |
| `suggest(<String> query, callback, context)` | `GeocodingResult[]` | Performs a geocoding query suggestion (this happens while typing) and returns the results to the callback in the provided context |
| `reverse(<L.LatLng> location, <Number> scale, callback, context)` | `GeocodingResult[]` | Performs a reverse geocoding query and returns the results to the callback in the provided context |

## GeocodingResult
Expand Down

0 comments on commit 9636bfe

Please sign in to comment.