Skip to content

Commit f7f886a

Browse files
authored
Update CHANGELOG.md
1 parent b62318e commit f7f886a

File tree

1 file changed

+32
-34
lines changed

1 file changed

+32
-34
lines changed

packages/instant-meilisearch/CHANGELOG.md

Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,47 @@
44

55
### Minor Changes
66

7-
- ed8b6a3: ### Major Changes
7+
- 5b6be19 & ed8b6a3: Added ability to override a selection of Meilisearch search parameters.
88

9-
- 5b6be19: Added ability to override a selection of Meilisearch search parameters.
10-
11-
⚠️ The returned value of the core `instantMeiliSearch` function has changed!
9+
⚠️ The returned value of the core `instantMeiliSearch` function has changed!
1210

13-
This change was necessary for the aforementioned ability to be implemented and
14-
applied in a clean manner.
15-
The necessary migration should be of minimal impact.
11+
This change was necessary for the aforementioned ability to be implemented and
12+
applied in a clean manner.
13+
The necessary migration should be of minimal impact.
1614

17-
### Migration
15+
### Migration
1816

19-
Change the following
17+
Change the following
2018

21-
```js
22-
// 1.
23-
const client = instantMeiliSearch(/*...*/);
24-
// 2.
25-
const searchClient = instantMeiliSearch(/*...*/);
26-
// 3.
27-
instantsearch({
28-
indexName: "movies",
29-
searchClient: instantMeiliSearch(/*...*/),
30-
});
31-
```
19+
```js
20+
// 1.
21+
const client = instantMeiliSearch(/*...*/);
22+
// 2.
23+
const searchClient = instantMeiliSearch(/*...*/);
24+
// 3.
25+
instantsearch({
26+
indexName: "movies",
27+
searchClient: instantMeiliSearch(/*...*/),
28+
});
29+
```
3230

33-
to the following
31+
to the following
3432

35-
```js
36-
// 1.
37-
const { searchClient: client } = instantMeiliSearch(/*...*/);
38-
// 2.
39-
const { searchClient } = instantMeiliSearch(/*...*/);
40-
// 3.
41-
instantsearch({
42-
indexName: "movies",
43-
searchClient: instantMeiliSearch(/*...*/).searchClient,
44-
});
45-
```
33+
```js
34+
// 1.
35+
const { searchClient: client } = instantMeiliSearch(/*...*/);
36+
// 2.
37+
const { searchClient } = instantMeiliSearch(/*...*/);
38+
// 3.
39+
instantsearch({
40+
indexName: "movies",
41+
searchClient: instantMeiliSearch(/*...*/).searchClient,
42+
});
43+
```
4644

47-
### Patch Changes
45+
### Patch Changes
4846

49-
- 06377ef: Fixes issue where backslashes ("\") and quotes (`"`) are not escaped in filters.
47+
- 06377ef: Fixes issue where backslashes ("\") and quotes (`"`) are not escaped in filters.
5048

5149
## [DEPRECATED] 1.0.0
5250

0 commit comments

Comments
 (0)