Mark dispose as Deprecated
#683
Merged
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
🦋 Changeset detectedLatest commit: b2cfe35 The changes in this PR will be included in the next version bump. This PR includes changesets to release 8 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the dispose method in AbstractPowerSyncDatabase to reduce confusion about its usage, directing users to use the close method instead.
- Adds a
@deprecatedJSDoc annotation to thedisposemethod with guidance to usecloseinstead - Updates changeset documentation to reflect the deprecation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/common/src/client/AbstractPowerSyncDatabase.ts | Overrides the inherited dispose method with deprecation annotation and documentation |
| .changeset/healthy-grapes-sit.md | Documents the deprecation change for release notes |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
rkistner
approved these changes
Aug 4, 2025
whygee-dev
pushed a commit
to whygee-dev/powersync-js
that referenced
this pull request
Oct 18, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Overview
The
AbstractPowerSyncDatabasecurrently extendsBaseObserverwhich exposes a publicdisposemethod. There aren't many use cases for calling this method directly. Its public visibility can cause confusion.This PR marks the
disposemethod as deprecated in order to avoid said confusion.