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

refactor(query-core): update tsdocs for mutation and query observer result #7399

Merged
merged 3 commits into from May 10, 2024

Conversation

bryanltobing
Copy link
Contributor

Content is directly taken from the website API docs.

https://tanstack.com/query/latest/docs/framework/react/reference/useQuery#usequery
https://tanstack.com/query/latest/docs/framework/react/reference/useMutation#usemutation

WHY

  • In some code editors like VSCode, we can hover through each result to get information about each key.
  • We can also go to the type definition and get all information without the need to open website docs.
Screen.Recording.2024-05-09.at.15.05.43.mov

Prev discussions

https://twitter.com/TkDodo/status/1784684695147483440

Copy link

vercel bot commented May 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
query ⬜️ Ignored (Inspect) Visit Preview May 10, 2024 2:15pm

Copy link

codesandbox-ci bot commented May 9, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit e2bc5cb:

Sandbox Source
@tanstack/query-example-angular-basic Configuration
@tanstack/query-example-react-basic-typescript Configuration
@tanstack/query-example-solid-basic-typescript Configuration
@tanstack/query-example-svelte-basic Configuration
@tanstack/query-example-vue-basic Configuration

Copy link
Collaborator

@TkDodo TkDodo left a comment

Choose a reason for hiding this comment

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

❤️

packages/query-core/src/types.ts Outdated Show resolved Hide resolved
packages/query-core/src/types.ts Outdated Show resolved Hide resolved
@TkDodo TkDodo changed the title docs(query-core): update tsdocs for mutation and query observer result refactor(query-core): update tsdocs for mutation and query observer result May 10, 2024
Copy link

nx-cloud bot commented May 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit e2bc5cb. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@TkDodo TkDodo merged commit bf4cf00 into TanStack:main May 10, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants