useStatus()

function useStatus(): Ref<{
  clientImplementation: SyncClientImplementation;
  connected: boolean;
  connecting: boolean;
  dataFlowStatus: {
     downloadError: {};
     downloading: boolean;
     downloadProgress: InternalProgressInformation;
     internalStreamSubscriptions: {
        active: boolean;
        expires_at: number;
        has_explicit_subscription: boolean;
        is_default: boolean;
        last_synced_at: number;
        name: string;
        parameters: any;
        priority: number;
        progress: {
           downloaded: number;
           total: number;
          };
       }[];
     uploadError: {};
     uploading: boolean;
    };
  downloadProgress: {
     downloadedFraction: number;
     downloadedOperations: number;
     totalOperations: number;
     untilPriority: ProgressWithOperations;
    };
  hasSynced: boolean;
  lastSyncedAt: {};
  priorityStatusEntries: {
     hasSynced: boolean;
     lastSyncedAt: {};
     priority: number;
    }[];
  syncStreams: {
     priority: number;
     progress: {
        downloadedFraction: number;
        downloadedOperations: number;
        totalOperations: number;
       };
     subscription: {
        active: boolean;
        expiresAt: {};
        hasExplicitSubscription: boolean;
        hasSynced: boolean;
        isDefault: boolean;
        lastSyncedAt: {};
        name: string;
        parameters: Record<string, any>;
       };
    }[];
  forStream: SyncStreamStatus;
  getMessage: string;
  isEqual: boolean;
  statusForPriority: SyncPriorityStatus;
  toJSON: SyncStatusOptions;
}>

Retrieve the current synchronization status of PowerSync.

Returns

Ref<{ clientImplementation: SyncClientImplementation; connected: boolean; connecting: boolean; dataFlowStatus: { downloadError: {}; downloading: boolean; downloadProgress: InternalProgressInformation; internalStreamSubscriptions: { active: boolean; expires_at: number; has_explicit_subscription: boolean; is_default: boolean; last_synced_at: number; name: string; parameters: any; priority: number; progress: { downloaded: number; total: number; }; }[]; uploadError: {}; uploading: boolean; }; downloadProgress: { downloadedFraction: number; downloadedOperations: number; totalOperations: number; untilPriority: ProgressWithOperations; }; hasSynced: boolean; lastSyncedAt: {}; priorityStatusEntries: { hasSynced: boolean; lastSyncedAt: {}; priority: number; }[]; syncStreams: { priority: number; progress: { downloadedFraction: number; downloadedOperations: number; totalOperations: number; }; subscription: { active: boolean; expiresAt: {}; hasExplicitSubscription: boolean; hasSynced: boolean; isDefault: boolean; lastSyncedAt: {}; name: string; parameters: Record<string, any>; }; }[]; forStream: SyncStreamStatus; getMessage: string; isEqual: boolean; statusForPriority: SyncPriorityStatus; toJSON: SyncStatusOptions; }>

SyncStatus

Example

<script setup>
import { useStatus } from '@powersync/vue';

const status = useStatus();
<script>

Deprecated

Use useStatus instead.