Skip to content

Commit 736dba0

Browse files
meili-bors[bot]Striftbrunoocasali
authored
Merge #1346
1346: Update `matchingStrategy` docs in autocomplete client README r=brunoocasali a=Strift This PR: - Removes documentation about `matchingStrategy` field in `options` (does not exist) - Removes the section about Matching Strategy for consistency Follows an incomplete update of documentation made in #1343, and actually fixes #1338 Thanks to `@sgilberg` for the report and review 🙌 Co-authored-by: Strift <[email protected]> Co-authored-by: Laurent Cazanove <[email protected]> Co-authored-by: Bruno Casali <[email protected]>
2 parents 7c43176 + 3f0e8f1 commit 736dba0

File tree

1 file changed

+0
-13
lines changed

1 file changed

+0
-13
lines changed

packages/autocomplete-client/README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,6 @@ The `options` field in the `meilisearchAutocompleteClient` function provides the
133133
- [`placeholderSearch`](#placeholder-search): Enable or disable placeholder search (default: `true`).
134134
- [`primaryKey`](#primary-key): Specify the primary key of your documents (default `undefined`).
135135
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
136-
- [`matchingStrategy`](#matching-strategy): Determine the search strategy on words matching (default `last`).
137136
- [`requestConfig`](#request-config): Use custom request configurations.
138137
- [`httpClient`](#custom-http-client): Use a custom HTTP client.
139138
- [`meiliSearchParams`](#meilisearch-search-parameters): Override search parameters sent to Meilisearch.
@@ -192,18 +191,6 @@ genres:
192191
{ keepZeroFacets : true } // default: false
193192
```
194193

195-
### Matching strategy
196-
197-
`matchingStrategy` gives you the possibility to choose how Meilisearch should handle the presence of multiple query words, see [documentation](https://www.meilisearch.com/docs/reference/api/search#matching-strategy).
198-
199-
For example, if your query is `hello world` by default Meilisearch returns documents containing either both `hello` and `world` or documents that only contain `hello`. This is the `last` strategy, where words are stripped from the right.
200-
The other strategy is `all`, where both `hello` and `world` **must** be present in a document for it to be returned.
201-
202-
203-
```js
204-
{ matchingStrategy: 'all' } // default last
205-
```
206-
207194
### Request Config
208195

209196
You can provide a custom request configuration. Available field can be [found here](https://fetch.spec.whatwg.org/#requestinit).

0 commit comments

Comments
 (0)