Skip to content
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.

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

feat(useFetch): Add query option #4443

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bkeepers
Copy link

@bkeepers bkeepers commented Dec 29, 2024

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

Description

This adds a query option to useFetch that will append query parameters to the URL. This is particularly useful for GET requests, which don't currently have a way of including a dynamic payload like POST, PUT, etc.

Query parameters

useFetch accepts query option to generate URL query params automatically from an object. query object can also work with existing query parameters in the URL.

useFetch('https://my-api.com/users', { query: { sortBy: 'username' } })

// Object query will be merged with existing query in the URL
useFetch('https://my-api.com/users?q=john', { query: { sortBy: 'username' } })

Replaces #3191, which is a little outdated and has merge conflicts. cc @jd-solanki
Closes #3183

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Dec 29, 2024
@ilyaliao
Copy link
Member

ilyaliao commented Jan 1, 2025

Based on the discussion in #586, perhaps we should reconsider whether this feature is necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

✨ Adding query option in useFetch (DX)
2 participants