Skip to content

Mark dispose as Deprecated #683

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 4, 2025
Merged

Mark dispose as Deprecated #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e164a3a
mark dispose as deprecated.
stevensJourney Aug 4, 2025
b2cfe35
Update .changeset/healthy-grapes-sit.md
stevensJourney Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/healthy-grapes-sit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/common': patch
---

Marked AbstractPowerSyncDatabase.dispose method as deprecated. The AbstractPowerSyncDatabase.close method should be used instead.
8 changes: 8 additions & 0 deletions packages/common/src/client/AbstractPowerSyncDatabase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,14 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
};
}

/**
* @deprecated Use {@link AbstractPowerSyncDatabase#close} instead.
* Clears all listeners registered by {@link AbstractPowerSyncDatabase#registerListener}.
*/
dispose(): void {
return super.dispose();
}

/**
* Locking mechanism for exclusively running critical portions of connect/disconnect operations.
* Locking here is mostly only important on web for multiple tab scenarios.
Expand Down