Skip to content

Commit 32ee1d5

Browse files
fix: better doc explanation
1 parent 9b62772 commit 32ee1d5

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/content/1.getting-started/3.usage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ onMounted(async () => {
103103
})
104104
</script>
105105
```
106-
107-
This composable accepts an optional key parameter:
108-
109-
* `key` - if you need multiple useAlgoliaRecommend calls, add a unique key to get passed to the userState('recommend-result') underneath, so new calls won't overwrite old data.
110-
106+
This composable returns the following:
111107

112108
* `result` will contain a value of a get method. It is reactive computed property that will be populated when a get method will fulfill. This result will have a form described [here](https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/#response)
113109
* `get` method is used to get the recommendations based on the criteria described [here](https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/#parameters) and an optional parameter of `requestOptions` that you can check out [here](https://www.algolia.com/doc/api-reference/api-methods/search/#method-param-requestoptions)
114110

111+
This composable also accepts an optional key parameter:
112+
113+
* `key` - if you need multiple useAlgoliaRecommend calls, add a unique key to get passed to the userState('recommend-result') underneath, so new calls won't overwrite old data.
114+
115115
For more details check out the official documentation of this method [here](https://www.algolia.com/doc/api-reference/api-methods/get-recommendations/)
116116

117117
## `useAlgoliaRef`

0 commit comments

Comments
 (0)