StoreEvent

interface
messages.ts:58

extends BaseMessage

An event emitted by a store, forwarded to extensions.

This is the primary data-flow message. Each StoreEvent carries the original event payload plus an array of JsonPatch operations describing the resulting state delta. Extensions can apply the patches incrementally or request a full StateSnapshot when needed.

Properties

NameTypeDescription
committedbooleantrue if the event passed middleware; false if bounced.
event{ channel: string; id: string; payload: unknown; truncated?: boolean; type: string }
patchesJsonPatch[]RFC 6902 JSON Patch operations describing state changes.
patchesTruncated?booleantrue when at least one patch value was replaced by a truncation marker.
reason?"vetoed" | "deduped" | "cascade"Why the event did not commit. Absent when it did.
snapshotVersionnumberMonotonically increasing snapshot version counter.
sourceIdstringUUID of the sender (store wrapper ID or extension ID).
sourceRoleDevtoolsRoleRole of the sender.
storeIdstring
timestampstringISO 8601 timestamp of when the message was created.
type"STORE_EVENT"Discriminant field identifying the message type.
vetoedBy?stringWhich middleware vetoed, when one did and it had a name.