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

docs(queries): rename success -> isSuccess #5110

Merged
merged 1 commit into from
Mar 11, 2023
Merged

Conversation

leon-fong
Copy link
Contributor

Origin version:

error - If the query is in an isError state, the error is available via the error property.
data - If the query is in a success state, the data is available via the data property.

Compared with the previous sentence, a success should be changed to an isSuccess

@vercel
Copy link

vercel bot commented Mar 10, 2023

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

1 Ignored Deployment
Name Status Preview Comments Updated
query ⬜️ Ignored (Inspect) Mar 10, 2023 at 4:46PM (UTC)

@codesandbox-ci
Copy link

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 e74943e:

Sandbox Source
@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

@TkDodo TkDodo merged commit b8b0562 into TanStack:main Mar 11, 2023
TkDodo pushed a commit to paul-sachs/query that referenced this pull request Mar 15, 2023
TkDodo added a commit that referenced this pull request Mar 15, 2023
…#4352)

* feat(devtools): enable setting loading/error via devtools

* Some cleanup

* refactor: use flex-gap to align buttons

* refactor: fix linter and dropdown reset

* refactor: operate directly on activeQuery

* Change buttons to toggle states

* Sneak some queryState into meta

* Added test for error and loading

* Fix lint

* Fix prettier formatting

* chore: releases should run on alpha/beta as well

* chore: extract package validation to an extra script (#5039)

* chore: extract package validation to an extra script

and run it during CI

* chore: add missing `build:types` script to solid-query

* docs: update link for v2 docs (#5044)

* docs: update link for v2 docs

* Update README.md

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>

* release: v4.24.12

* fix(react-query-devtools): do not stretch query status label (#5063)

Do not stretch query status label (fresh, fetching, paused, stale, inactive) shown on Query Details view.

* release: v4.24.13

* fix(react-query-devtools): add 'use client' directive to disable SSR (#5041)

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>

* release: v4.24.14

* feat(core): re-export matchQuery from utils (#5070)

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>

* release: v4.25.0

* feat(query-core): Add global onSettled callbacks for QueryCache and MutationCache (#5075)

* feat(query-core): Add global onSettled callbacks for QueryCache and MutationCache

* test: tests for query onSettled callback

* test: tests for mutation onSettled callback

* docs: onSettled callbacks

* release: v4.26.0

* fix(core): make sure mutations get updated options (#5085)

this fixes an issue around stale closures where callbacks are not updated, thus are called with wrong values in the closure

* release: v4.26.1

* fix(eslint-plugin): improve object property checks (#5079)

* fix(eslint-plugin): improve object property checks

* prettier

* release: v4.26.2

* docs: add adapter dropdown to issue template (#5108)

* docs(queries): rename `success` (#5110)

* chore: `test:lib` task-caching w/ Nx (#5116)

* adding quick caching test

* reverting workflow change

* updating pr yml to test nx speed

* fixing yml on property

* fixing yml on property

* fixing target name

* upping to running4 in parallel

* upping to running 5 in parallel

* upping to running 6 in parallel

* upping to running 7 in parallel

* upping to running 8 in parallel

* upping to running 9 in parallel

* upping to running 10 in parallel

* opting for --parallel=5

* cleaning up nx.json

* revert touching of ci.yml file

* reverting on property of pr.yml file

* updating root pacakge.json test:lib command

* fixing frozen lockfile error in ci

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>

* chore: fix missing dependencies (#5127)

* chore: include scripts directory in linting

and fix issues

* chore: add missing dependencies chalk and semver

* chore: turning off Nx daemon in CI (#5128)

* chore: downgrade chalk to v4 because v5 is ESM only (#5130)

see: https://stackoverflow.com/questions/70309135/chalk-error-err-require-esm-require-of-es-module

* fix(eslint-plugin): ignore internal properties (#5119)

* chore: resolve merge conflicts

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
Co-authored-by: Abhijeet Singh <contact.abhijeetsingh@gmail.com>
Co-authored-by: Tanner Linsley <tannerlinsley@users.noreply.github.com>
Co-authored-by: janinegygax <32389974+janinegygax@users.noreply.github.com>
Co-authored-by: Youssouf Oumar <63708012+yousoumar@users.noreply.github.com>
Co-authored-by: remolueoend <remolueoend@users.noreply.github.com>
Co-authored-by: Eliya Cohen <co.eliya2@gmail.com>
Co-authored-by: Damian Osipiuk <osipiukd+git@gmail.com>
Co-authored-by: Leon Fong <ooohmydawn@hotmail.com>
Co-authored-by: Zachary DeRose <zack@nrwl.io>
Co-authored-by: Zachary DeRose <zack.derose@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants