Skip to content

Update README with SDK changes and add pagination examples #822

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

Jump to bottom
Merged
meili-bors merged 6 commits into from
Mar 9, 2025
Merged

Update README with SDK changes and add pagination examples #822

meili-bors merged 6 commits into from
Mar 9, 2025

Conversation

@samuele-ruffino96
Copy link

@samuele-ruffino96 samuele-ruffino96 commented Feb 21, 2025 •
edited
Loading

Pull Request

What does this PR do?

  • Updates the README example code to show the necessity to cast the returned value (new Searchable interface) to SearchResult
  • Adds a new comprehensive example demonstrating custom search with pagination
  • Shows practical usage of pagination parameters like setPage() and setHitsPerPage()
  • Includes example JSON response showing pagination metadata (totalPages, hitsPerPage, etc.)

PR checklist

  • Changes are clearly described in the PR description above
  • Contributing guidelines have been reviewed (needs confirmer)
  • PR title accurately describes changes: "fix(docs): update README example to reflect latest sdk changes"

samuele ruffino and others added 5 commits February 21, 2025 17:53
fix(docs): update README example to reflect latest sdk changes
3375e79
feat(docs): add custom search with pagination example
ffd4be0 
Provide an example for custom search with pagination for clarity and ease of use.
refactor: update examples in README for search result types
f01b153 
Updated README examples to use correct SearchResult and SearchResultPaginated types for clarity and accuracy.
fix(docs): fix import
0775fa2
@Strift
Merge branch 'main' into docs-update
9649268
Strift
Strift reviewed Mar 9, 2025
View reviewed changes
Strift
Strift approved these changes Mar 9, 2025
View reviewed changes
Copy link
Contributor

@Strift Strift left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution 🙌

bors merge

@meili-bors
Copy link
Contributor

meili-bors bot commented Mar 9, 2025

Build succeeded:

  • integration-and-unit-tests
  • linter

@meili-bors meili-bors bot merged commit 6fc2b51 into meilisearch:main Mar 9, 2025
3 checks passed
@curquiza curquiza added the documentation Improvements or additions to documentation label Mar 25, 2025
@curquiza curquiza changed the title docs: update README with SDK changes and add pagination examples Update README with SDK changes and add pagination examples Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Strift Strift Strift approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@samuele-ruffino96 @Strift @curquiza