PersistentAI API Documentation / @persistentai/fireflow-vfs / / VFSEvent

Interface: VFSEvent

Defined in: packages/fireflow-vfs/src/types/events.ts:65

VFS Event - emitted for real-time updates and flow triggers

Properties

branchName?

optional branchName: string

Defined in: packages/fireflow-vfs/src/types/events.ts:75

Branch name (if applicable)

---

commitId?

optional commitId: string

Defined in: packages/fireflow-vfs/src/types/events.ts:79

Commit ID (for commit-related events)

---

createdAt

createdAt: Date

Defined in: packages/fireflow-vfs/src/types/events.ts:85

Event timestamp

---

eventName

eventName: string

Defined in: packages/fireflow-vfs/src/types/events.ts:73

Event name for routing (generated from eventType via getEventName())

---

eventType

eventType: VFSEventType

Defined in: packages/fireflow-vfs/src/types/events.ts:71

Event type

---

id

id: string

Defined in: packages/fireflow-vfs/src/types/events.ts:67

Event ID (EV + 20 alphanumeric chars)

---

metadata?

optional metadata: Record<string, unknown>

Defined in: packages/fireflow-vfs/src/types/events.ts:83

Additional event-specific metadata

---

path?

optional path: string

Defined in: packages/fireflow-vfs/src/types/events.ts:77

File path (if applicable)

---

treeOperations?

optional treeOperations: TreeOperation[]

Defined in: packages/fireflow-vfs/src/types/events.ts:87

Tree operations for frontend state updates (NEW)

---

userId

userId: string

Defined in: packages/fireflow-vfs/src/types/events.ts:81

User ID who performed the action

---

workspaceId

workspaceId: string

Defined in: packages/fireflow-vfs/src/types/events.ts:69

Workspace ID