Add JS hosted documentation #1678
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1678 +/- ##
=======================================
Coverage 96.94% 96.94%
=======================================
Files 21 21
Lines 818 818
Branches 85 85
=======================================
Hits 793 793
+ Misses 25 24 -1
- Partials 0 1 +1 ☔ View full report in Codecov by Sentry. |
curquiza
reviewed
Jul 24, 2024
curquiza
reviewed
Jul 24, 2024
meili-bors bot
added a commit
that referenced
this pull request
Aug 26, 2024
1695: Update version for the next release (v0.42.0) r=brunoocasali a=meili-bot _This PR is auto-generated._ The automated script updates the version of meilisearch-js to a new version: "v0.42.0" CHANGELOGS 👇 This version introduces features released on Meilisearch v1.10.0 🎉 Check out the changelog of [Meilisearch v1.10.0](https://github.com/meilisearch/meilisearch/releases/tag/v1.10.0) for more information on the changes. ##⚠️ Breaking changes * Improve errors (#1656) `@/flevi29` More details [here](#1656 (comment)) * Changes related to Hybrid search (experimental) for the REST embedder (#1692) `@/mdubus` - Removed parameters: `query`, `inputField`, `inputType`, `pathToEmbeddings` and `embeddingObject`. - Replaced by `request` and `response` - New parameter: `headers` ## 🚀 Enhancements * Hybrid search improvements (#1692) `@/mdubus` - Add `url` parameter to the OpenAI embedder - `dimensions` is now available as an optional parameter for `ollama` embedders. * Add federated search parameters (#1689) `@/flevi29` ```js client.multiSearch({ federation: {}, queries: [ { indexUid: 'movies', q: 'batman', limit: 5, }, { indexUid: 'comics', q: 'batman', limit: 5, }, ] }) ``` * Add capabilities to update documents by function (#1691) `@/flevi29` ```js index.updateDocumentsByFunction({ context: { ctx: 'Harry' }, filter: 'id = 4', function: 'doc.comment = `Yer a wizard, ${context.ctx}!`', }) ) ``` * Add language settings (#1693) `@/flevi29` ```js client.index('INDEX_NAME').updateLocalizedAttributes([ { attributePatterns: ['jpn'], locales: ['*_ja'] }, ];) ``` * Add `locale` search parameter (#1693) `@/flevi29` ```js client.index('INDEX_NAME').search('進撃の巨人', { locales: ['jpn'] }) ``` ## ⚙️ Maintenance/misc * Add JS hosted documentation (#1678) `@/amit-ksh` Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
This was referenced Sep 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Related issue
Close #1240
Preview
JS docs Preview
What does this PR do?
typedocpackage.mainbranch.TODO
feat/js-docsfrom docs workflow.PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!