Upgrade readme & changelog to reflect change from requestConfig to requestInit

[jeremylynch]

In Meilisearch v0.50.0:

The Meilisearch class now accepts a requestInit parameter instead of requestConfig. Parameters of requestInit are the same, except it no longer accepts signal.

Details here: https://github.com/meilisearch/meilisearch-js/releases

This package needs to update readme

Summary by CodeRabbit

• Documentation
  • Updated the changelog to note a breaking change in the Meilisearch dependency, specifically the renaming of a configuration option.
  • Revised the README to reflect the updated option name in both the customization options list and example code.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0b28571

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The documentation for the @meilisearch/instant-meilisearch package was updated to reflect a parameter name change from requestConfig to requestInit in both the changelog and README. No functional code or API changes were made; only documentation was updated to match the new parameter name.

Changes

Cohort / File(s)	Change Summary
Changelog Update packages/instant-meilisearch/CHANGELOG.md	Updated changelog to note the breaking change: parameter renamed from requestConfig to requestInit in Meilisearch class.
Documentation Update packages/instant-meilisearch/README.md	Changed all references and examples from requestConfig to requestInit in the customization options and code samples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

The docs have changed, a name anew,
From requestConfig to requestInit—it's true!
No code to check, just words to read,
A rabbit's hop is all you need.
With every tweak, our docs stay bright,
So searchers' journeys stay light! 🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🔭 Outside diff range comments (1)

packages/instant-meilisearch/README.md (1)

241-247: Call out that signal is no longer supported and tighten wording

Great example. Two small improvements:

• Mention that signal is not supported anymore with requestInit (as of meilisearch-js v0.50.0).
• Minor grammar: “Available fields can be found here.”

Suggested additions (outside the selected range, near the paragraph above the snippet):

You can provide a custom request configuration. Available fields can be [found here](https://fetch.spec.whatwg.org/#requestinit). Note: as of Meilisearch JS v0.50.0, `signal` is not supported in `requestInit`. If you need request cancellation, consider handling it in your custom `httpClient`.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e0dcc1 and 0b28571.

📒 Files selected for processing (2)

• packages/instant-meilisearch/CHANGELOG.md (1 hunks)
• packages/instant-meilisearch/README.md (2 hunks)

[Strift]

Hello @jeremylynch and thanks for your first contribution in this repository 🙌