Sync from docs: add @powersync/common as canonical API reference (powersync-docs #542) - #61
Open
bean1352 wants to merge 1 commit into
Open
Sync from docs: add @powersync/common as canonical API reference (powersync-docs #542)#61bean1352 wants to merge 1 commit into
bean1352 wants to merge 1 commit into
Conversation
In JS SDK v2, PowerSyncDatabase and SyncStatus are exported as interfaces from @powersync/common (CommonPowerSyncDatabase and SyncStatus) rather than as classes in SDK-specific packages. The canonical API docs for these types are now at https://powersync-ja.github.io/powersync-js/common. Mirrors docs change from powersync-docs PR #542.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Source docs PR: powersync-ja/powersync-docs#542
What changed in docs
In JS SDK v2,
PowerSyncDatabaseandSyncStatusare exported as interfaces from@powersync/common(CommonPowerSyncDatabaseandSyncStatus) rather than as concrete classes in each SDK package. The docs PR updated all API documentation links to point to these canonical@powersync/commoninterface pages.Skill updates in this PR
skills/powersync/references/sdks/powersync-js.md: Added a row for the@powersync/commonpackage API reference to the resource table, noting it is the canonical source forCommonPowerSyncDatabase(the public database interface) andSyncStatusin SDK v2.Notes for reviewer
The docs PR also renamed
WASQLiteDBAdaptertoWASQLiteOpenFactoryin the documentation, butpowersync-js.mdalready usesWASQLiteOpenFactory, so no change was needed there.An open PR (#60) for docs PR #524 already updates
powersync-js.mdwith broader v2 API changes (logger API,dataFlowStatusflattening, VFS config). The change in this PR is additive and does not conflict with those edits.No other skill files contain the affected URL patterns or class names. The
production-readiness-guide.mdxchange (consolidating threeSyncStatuslinks into one) does not have a skill counterpart.Generated by Claude Code