Interface SynchronizationState

Represents the state of an active synchronization process.

Source

interface SynchronizationState {
  isActive: boolean;
  progress: SyncProgress | null;
  report: SyncReport | null;
  error: string | null;
  abortController: AbortController | null;
  isPaused: boolean;
  resumeAvailable: boolean;
  resumeMetadata: {
    remainingMediaIds: number[];
    timestamp: number;
  } | null;
}

interface SynchronizationState {
    isActive: boolean;
    progress: null | SyncProgress;
    report: null | SyncReport;
    error: null | string;
    abortController: null | AbortController;
    isPaused: boolean;
    resumeAvailable: boolean;
    resumeMetadata: null | { remainingMediaIds: number[]; timestamp: number };
}

Index

Properties

isActive progress report error abortController isPaused resumeAvailable resumeMetadata

Properties

isActive

isActive: boolean

Whether synchronization is currently running.

progress

progress: null | SyncProgress

Current progress details, or null if not started.

report

report: null | SyncReport

Completed or partial sync report, or null.

error

error: null | string

Error message if sync failed, or null.

abortController

abortController: null | AbortController

Controller for cancelling the sync, or null.

isPaused

isPaused: boolean

Whether the sync is paused and resumable.

resumeAvailable

resumeAvailable: boolean

Whether a paused sync can be resumed.

resumeMetadata

resumeMetadata: null | { remainingMediaIds: number[]; timestamp: number }

Metadata about available resume state.