Skip to content

Commit

Permalink
Adds documentation for suggestion endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
coconutcraig committed Aug 20, 2019
1 parent 27185eb commit 5add582
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,10 @@ Set a filter which will tell the API to return locations where the supplied serv

Set a sorting string to determine how the returned results are sorted.

- `suggest(query: string)`

Retrieve a set of location suggestions based on the given query. _(not publicly available yet)_

- `take(limit: number)`

Set the limit which you want returned.
Expand Down Expand Up @@ -344,6 +348,10 @@ class Locations {
.take(limit)
.get();
}

async suggestions(query) {
return await this.api.suggest(query);
}
}
```

Expand Down

0 comments on commit 5add582

Please sign in to comment.