docs: warn about isPersisted vs isPersisted.promise footgun#1322
Open
Danny-Devs wants to merge 1 commit intoTanStack:mainfrom
Open
docs: warn about isPersisted vs isPersisted.promise footgun#1322Danny-Devs wants to merge 1 commit intoTanStack:mainfrom
Danny-Devs wants to merge 1 commit intoTanStack:mainfrom
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an
IMPORTANTcallout to the Transaction States section warning thatawait tx.isPersistedsilently resolves immediately becauseDeferredis not a thenable. Users must usetx.isPersisted.promise.This is a real-world bug we hit in production. TypeScript does not flag it because
awaitacceptsany. The consequence is that forms clear, navigation fires, and success messages display before the server confirms the write — and if the server rejects, the rollback happens silently with no error handling.Context:
Deferred<T>(defined insrc/deferred.ts) has no.then()methodawait nonThenableresolves to the value itself per the JS spec.promisecorrectly, but there's no explicit warning about omitting it