Packages@robojs/roadmap
SyncOptions
Interface: SyncOptions
Options for synchronizing roadmap data to Discord.
Properties
| Property | Type | Description |
|---|---|---|
dryRun? | boolean | Optional flag to preview changes without applying them (defaults to false) |
guild | Guild | The Discord guild to sync |
onProgress? | (update: SyncProgressUpdate) => void | Promise<void> | Optional callback invoked during sync to report progress |
provider | RoadmapProvider<ProviderConfig> | The roadmap provider instance |
signal? | AbortSignal | 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? | string | Optional sync identifier for traceability across logs/UI |