Skip to content

Update matchingStrategy docs in autocomplete client README #1346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 23, 2024
Merged

Update matchingStrategy docs in autocomplete client README #1346

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
066468f
Remove docs
Strift Dec 19, 2024
49eabdd
Merge branch 'main' into chore/update-meilisearchparams-docs
Strift Dec 19, 2024
3f0e8f1
Merge branch 'main' into chore/update-meilisearchparams-docs
brunoocasali Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions packages/autocomplete-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,6 @@ The `options` field in the `meilisearchAutocompleteClient` function provides the
- [`placeholderSearch`](#placeholder-search): Enable or disable placeholder search (default: `true`).
- [`primaryKey`](#primary-key): Specify the primary key of your documents (default `undefined`).
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
- [`matchingStrategy`](#matching-strategy): Determine the search strategy on words matching (default `last`).
- [`requestConfig`](#request-config): Use custom request configurations.
- [`httpClient`](#custom-http-client): Use a custom HTTP client.
- [`meiliSearchParams`](#meilisearch-search-parameters): Override search parameters sent to Meilisearch.
Expand Down Expand Up @@ -192,18 +191,6 @@ genres:
{ keepZeroFacets : true } // default: false
```

### Matching strategy

`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).

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.
The other strategy is `all`, where both `hello` and `world` **must** be present in a document for it to be returned.


```js
{ matchingStrategy: 'all' } // default last
```

### Request Config

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