Skip to content

feat: expose connection options #726

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 8 commits into from
Oct 2, 2025
Merged

feat: expose connection options #726

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
db49af3
feat: expose connection options
khawarizmus Sep 24, 2025
a5656f8
feat: expose connection options and connector in AbstractPowerSyncDat…
khawarizmus Sep 25, 2025
ac42343
Version Packages (#718)
github-actions[bot] Sep 29, 2025
9a959f0
Sync streams demo (#721)
simolus3 Sep 29, 2025
d193c18
docs: document the connector getter
Oct 2, 2025
d549b41
docs: documented the connection option getter
Oct 2, 2025
c2bc2c1
feat: expose connection and connection options in connect()
Oct 2, 2025
d1f8396
Merge branch 'main' into expose-connection-params
Oct 2, 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
11 changes: 11 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 @@ -181,6 +181,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
* Current connection status.
*/
currentStatus: SyncStatus;
connectionOptions: PowerSyncConnectionOptions;

sdkVersion: string;

Expand Down Expand Up @@ -514,6 +515,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
*/
async connect(connector: PowerSyncBackendConnector, options?: PowerSyncConnectionOptions) {
const resolvedOptions: InternalConnectionOptions = options ?? {};
this.connectionOptions = resolvedOptions;
resolvedOptions.serializedSchema = this.schema.toJSON();

return this.connectionManager.connect(connector, resolvedOptions);
Expand Down Expand Up @@ -592,6 +594,15 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
await this.iterateAsyncListeners(async (cb) => cb.closed?.());
}

/**
* Get the connection options used to connect to the PowerSync backend instance.
*
* @returns The connection options used to connect to the PowerSync backend instance.
*/
getConnectionOptions(): PowerSyncConnectionOptions | null {
return this.connectionOptions ?? null;
}

/**
* Get upload queue size estimate and count.
*/
Expand Down