Skip to content

Add JSDoc comment to mutation return value behavior#893

Merged
kobiebotha merged 3 commits intomainfrom
polish/jsdoc-mutation-returning-note
Mar 12, 2026
Merged

Add JSDoc comment to mutation return value behavior#893
kobiebotha merged 3 commits intomainfrom
polish/jsdoc-mutation-returning-note

Conversation

@kobiebotha
Copy link
Contributor

Builds off powersync-ja/powersync-docs#378 (which was inspired by #865 (comment))

When using the default client-side JSON-based view system, rowsAffected on QueryResult may be 0 for successful UPDATE and DELETE statements.

This PR documents the behavior and recommends using a RETURNING clause if needed.

Not including a changeset since the docs can update when the next batch of changes are released.

@kobiebotha kobiebotha requested a review from rkistner March 12, 2026 15:09
@changeset-bot
Copy link

changeset-bot bot commented Mar 12, 2026

⚠️ No Changeset found

Latest commit: 2844b1d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@kobiebotha kobiebotha marked this pull request as ready for review March 12, 2026 15:10
@kobiebotha kobiebotha merged commit b90ac09 into main Mar 12, 2026
7 of 9 checks passed
@kobiebotha kobiebotha deleted the polish/jsdoc-mutation-returning-note branch March 12, 2026 15:52
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.

2 participants