Skip to content

Commit 2fbded1

Browse files
committed
Valid JSdoc links
1 parent d67313e commit 2fbded1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

packages/powersync-sdk-common/src/client/AbstractPowerSyncDatabase.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
247247
/**
248248
* Close the sync connection.
249249
*
250-
* Use [connect] to connect again.
250+
* Use {@link connect} to connect again.
251251
*/
252252
async disconnect() {
253253
this.abortController?.abort();
@@ -295,7 +295,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
295295
/*
296296
* Close the database, releasing resources.
297297
*
298-
* Also [disconnect]s any active connection.
298+
* Also disconnects any active connection.
299299
*
300300
* Once close is called, this connection cannot be used again - a new one
301301
* must be constructed.
@@ -332,12 +332,12 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
332332
*
333333
* Returns null if there is no data to upload.
334334
*
335-
* Use this from the [PowerSyncBackendConnector.uploadData] callback.
335+
* Use this from the {@link PowerSyncBackendConnector.uploadData} callback.
336336
*
337-
* Once the data have been successfully uploaded, call [CrudBatch.complete] before
337+
* Once the data have been successfully uploaded, call {@link CrudBatch.complete} before
338338
* requesting the next batch.
339339
*
340-
* Use [limit] to specify the maximum number of updates to return in a single
340+
* Use {@link limit} to specify the maximum number of updates to return in a single
341341
* batch.
342342
*
343343
* This method does include transaction ids in the result, but does not group
@@ -383,12 +383,12 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
383383
*
384384
* Returns null if there is no data to upload.
385385
*
386-
* Use this from the [PowerSyncBackendConnector.uploadData]` callback.
386+
* Use this from the {@link PowerSyncBackendConnector.uploadData} callback.
387387
*
388-
* Once the data have been successfully uploaded, call [CrudTransaction.complete] before
388+
* Once the data have been successfully uploaded, call {@link CrudTransaction.complete} before
389389
* requesting the next transaction.
390390
*
391-
* Unlike [getCrudBatch], this only returns data from a single transaction at a time.
391+
* Unlike {@link getCrudBatch}, this only returns data from a single transaction at a time.
392392
* All data for the transaction is loaded into memory.
393393
*/
394394
async getNextCrudTransaction(): Promise<CrudTransaction> {
@@ -471,7 +471,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
471471

472472
/**
473473
* Takes a read lock, without starting a transaction.
474-
* In most cases, [readTransaction] should be used instead.
474+
* In most cases, {@link readTransaction} should be used instead.
475475
*/
476476
async readLock<T>(callback: (db: DBAdapter) => Promise<T>) {
477477
await this.waitForReady();
@@ -480,7 +480,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
480480

481481
/**
482482
* Takes a global lock, without starting a transaction.
483-
* In most cases, [writeTransaction] should be used instead.
483+
* In most cases, {@link writeTransaction} should be used instead.
484484
*/
485485
async writeLock<T>(callback: (db: DBAdapter) => Promise<T>) {
486486
await this.waitForReady();
@@ -564,7 +564,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
564564
/**
565565
* Create a Stream of changes to any of the specified tables.
566566
*
567-
* This is preferred over [watch] when multiple queries need to be performed
567+
* This is preferred over {@link watch} when multiple queries need to be performed
568568
* together when data is changed.
569569
*
570570
* Note, do not declare this as `async *onChange` as it will not work in React Native

0 commit comments

Comments
 (0)