Skip to main content

Interface: SyncOptions

Options for synchronizing roadmap data to Discord.

Properties​

dryRun?​

optional dryRun: boolean;

Optional flag to preview changes without applying them (defaults to false)

guild​

guild: Guild;

The Discord guild to sync

onProgress()?​

optional onProgress: (update) => void | Promise<void>;

Optional callback invoked during sync to report progress

Parameters​

ParameterType
updateSyncProgressUpdate

Returns​

void | Promise<void>

provider​

provider: RoadmapProvider<ProviderConfig>;

The roadmap provider instance

signal?​

optional signal: any;

Optional abort signal that allows callers to cancel an in-flight sync.

When triggered, the sync stops before processing the next card and throws a SyncCanceledError, preserving progress up to that point.

syncId?​

optional syncId: string;

Optional sync identifier for traceability across logs/UI