Skip to content

Commit 86623f4

Browse files
committed
Improve docs
1 parent 0ecd906 commit 86623f4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

packages/powersync_core/lib/src/sync/sync_status.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,9 @@ final class InternalSyncDownloadProgress {
326326
/// This reports the `total` amount of operations to download, how many of them
327327
/// have alreaady been `completed` and finally a `fraction` indicating relative
328328
/// progress (as a number between `0.0` and `1.0`)
329+
///
330+
/// To obtain these values, use [SyncDownloadProgress] available through
331+
/// [SyncStatus.downloadProgress].
329332
typedef ProgressWithOperations = ({
330333
int total,
331334
int completed,

0 commit comments

Comments
 (0)