Skip to content
D
Documentation

Dsl — interfaces s–u

reference
2 min readUpdated

Interfaces S–U

Import these from @grafloria/engine.

Interfaces

SyncMetrics

ts
interface SyncMetrics

Properties

NameTypeDefaultDescription
totalSyncsnumberTotal syncs performed
textToVisualnumberText → Visual syncs
visualToTextnumberVisual → Text syncs
errorsnumberSync errors
conflictsnumberConflicts resolved
averageSyncTimenumberAverage sync time (ms)
sessionDurationnumberSession duration (ms)

SyncOptions

ts
interface SyncOptions

Properties

NameTypeDefaultDescription
debounceMs?numberDebounce delay in milliseconds (default: 300)
debug?booleanEnable debug logging
autoLayout?booleanAuto-apply layout after text changes
generatorOptions?GeneratorOptionsGenerator options for visual→text sync
transformerOptions?TransformOptionsTransformer options for text→visual sync

SyncState

ts
interface SyncState

Properties

NameTypeDefaultDescription
activebooleanIs sync currently active
lastEditSourceEditSourceLast edit source
lastSyncDirectionSyncDirectionLast sync direction
syncingbooleanSync in progress
pendingCountnumberNumber of pending syncs
stats{ textToVisualCount: number; visualToTextCount: number; conflictsResolved: number; lastSyncTime: number; }Statistics

SyncStatus

ts
interface SyncStatus

Properties

NameTypeDefaultDescription
status'idle' | 'syncing' | 'error' | 'conflict'Current status
messagestringStatus message
lastSync?DateLast sync timestamp
lastSyncDuration?numberLast sync duration (ms)
error?stringError message if status is 'error'

Token

Represents a single token from the lexical analysis

ts
interface Token

Properties

NameTypeDefaultDescription
typeTokenType
valuestring
linenumber
columnnumber
startIndexnumber
endIndexnumber

TransformOptions

ts
interface TransformOptions

Properties

NameTypeDefaultDescription
defaultNodeSize?{ width: number; height: number }Default node size if not specified
nodeSpacing?numberSpacing between auto-positioned nodes
startPosition?{ x: number; y: number }Starting position for auto-positioned nodes
autoPosition?booleanAuto-generate positions (true) or use default position for all (false)
diagramName?stringName for the generated diagram

UmlSpec

ts
interface UmlSpec

Properties

NameTypeDefaultDescription
classesUmlSpecClass[]
relationshipsUmlSpecRelationship[]

Was this page helpful?

Dsl — interfaces s–u — Grafloria