docs(postgrest): add upsert tsdoc examples and fix response/options #1882
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 missing @example blocks to the upsert TSDoc in postgrest-js.
onConflictoption to the exact-count exampleThis improves the accuracy of the upsert examples and aligns them with the actual behavior of the JS client.
🔍 Description
Updates the
upsertTSDoc with accurate, typedoc-native examples and correct response data.This makes the behavior clearer for consumers of the PostgREST client.
What changed?
@exampleblocks showcasing common upsert patternsonConflictis present where requiredWhy was this change needed?
The previous examples were outdated and did not reflect the actual behavior returned by the client.
This improves clarity for developers using
upsert.Related: supabase/supabase#40658 fixes supabase/supabase#40653
📸 Screenshots/Examples
N/A — all changes are within TSDoc.
🔄 Breaking changes
📋 Checklist
<type>(<scope>): <description>npx nx formatto ensure consistent formatting📝 Additional notes
None.