Interface SyncManagerProps

Props for the SyncManager component.

Source

export interface SyncManagerProps {
  entries: AniListMediaEntry[];
  token: string;
  onComplete?: (report: SyncReport) => void;
  onCancel?: () => void;
  autoStart?: boolean;
  syncState?: {
    isActive: boolean;
    progress: SyncProgress | null;
    report: SyncReport | null;
    error: string | null;
    isPaused?: boolean;
    resumeAvailable?: boolean;
    resumeMetadata?: {
      remainingMediaIds: number[];
      timestamp: number;
    } | null;
  };
  syncActions?: {
    startSync: (
      entries: AniListMediaEntry[],
      token: string,
      _?: undefined,
      displayOrderMediaIds?: number[],
    ) => Promise<void>;
    cancelSync: () => void;
    pauseSync?: () => void;
    resumeSync?: (
      entries: AniListMediaEntry[],
      token: string,
      _?: undefined,
      displayOrderMediaIds?: number[],
    ) => Promise<void>;
  };
  incrementalSync?: boolean;
  onIncrementalSyncChange?: (value: boolean) => void;
  displayOrderMediaIds?: number[];
}
interface SyncManagerProps {
    entries: AniListMediaEntry[];
    token: string;
    onComplete?: (report: SyncReport) => void;
    onCancel?: () => void;
    autoStart?: boolean;
    syncState?: {
        isActive: boolean;
        progress: null | SyncProgress;
        report: null | SyncReport;
        error: null | string;
        isPaused?: boolean;
        resumeAvailable?: boolean;
        resumeMetadata?: null | { remainingMediaIds: number[]; timestamp: number };
    };
    syncActions?: {
        startSync: (
            entries: AniListMediaEntry[],
            token: string,
            _?: undefined,
            displayOrderMediaIds?: number[],
        ) => Promise<void>;
        cancelSync: () => void;
        pauseSync?: () => void;
        resumeSync?: (
            entries: AniListMediaEntry[],
            token: string,
            _?: undefined,
            displayOrderMediaIds?: number[],
        ) => Promise<void>;
    };
    incrementalSync?: boolean;
    onIncrementalSyncChange?: (value: boolean) => void;
    displayOrderMediaIds?: number[];
}

Properties

entries token onComplete? onCancel? autoStart? syncState? syncActions? incrementalSync? onIncrementalSyncChange? displayOrderMediaIds?

Properties

entries

entries: AniListMediaEntry[]

Array of AniList media entries to synchronize with detailed metadata.

token

token: string

AniList authentication bearer token for API requests.

OptionalonComplete

onComplete?: (report: SyncReport) => void

Optional callback invoked upon sync completion, receives the sync report with results.

OptionalonCancel

onCancel?: () => void

Optional callback invoked when user cancels the sync operation.

OptionalautoStart

autoStart?: boolean

Whether to automatically initiate sync on component mount (default: true).

OptionalsyncState

syncState?: {
    isActive: boolean;
    progress: null | SyncProgress;
    report: null | SyncReport;
    error: null | string;
    isPaused?: boolean;
    resumeAvailable?: boolean;
    resumeMetadata?: null | { remainingMediaIds: number[]; timestamp: number };
}

Optional current sync state containing progress, report, errors, and resume metadata.

OptionalsyncActions

syncActions?: {
    startSync: (
        entries: AniListMediaEntry[],
        token: string,
        _?: undefined,
        displayOrderMediaIds?: number[],
    ) => Promise<void>;
    cancelSync: () => void;
    pauseSync?: () => void;
    resumeSync?: (
        entries: AniListMediaEntry[],
        token: string,
        _?: undefined,
        displayOrderMediaIds?: number[],
    ) => Promise<void>;
}

Optional object with sync orchestration functions (start, cancel, pause, resume).

OptionalincrementalSync

incrementalSync?: boolean

Whether to break large progress jumps into incremental steps for better AniList activity merging.

OptionalonIncrementalSyncChange

onIncrementalSyncChange?: (value: boolean) => void

Optional callback when user toggles incremental sync mode.

OptionaldisplayOrderMediaIds

displayOrderMediaIds?: number[]

Optional array of media IDs to control the display order in UI.

Settings

Member Visibility

On This Page

Properties