Skip to main content

Interface: WorkflowStreamItem<T>

workflowStreams.WorkflowStreamItem

A single item in the workflow stream log (user-facing).

Generic on the decoded data type T. Default T = Payload matches what WorkflowStreamClient.subscribe yields — the raw payload, with metadata.encoding available for downstream decode. Subscribing through a TopicHandle narrows T to the handle's bound type, with the default payload converter applied per item.

The offset field is populated by the poll handler from the item's position in the global log.

Type parameters

NameType
TPayload

Properties

data

data: T


offset

offset: number


topic

topic: string