PURISTA API

---

PURISTA API / @purista/core / StreamDefinition

Type Alias: StreamDefinition<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, ChunkType, FinalType, Resources, Invokes, StreamInvokes, EmitList, MetadataType, QueueInvokes, AgentInvokes>

StreamDefinition<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, ChunkType, FinalType, Resources, Invokes, StreamInvokes, EmitList, MetadataType, QueueInvokes, AgentInvokes> = object

Defined in: core/types/stream/StreamDefinition.ts:11

Type Parameters

S

S extends ServiceClass

MessagePayloadType

MessagePayloadType

MessageParamsType

MessageParamsType

FunctionPayloadType

FunctionPayloadType

FunctionParamsType

FunctionParamsType

ChunkType

ChunkType

FinalType

FinalType

Resources

Resources extends Record<string, unknown>

Invokes

Invokes extends InvokeList

StreamInvokes

StreamInvokes extends StreamInvokeList

EmitList

EmitList extends Record<string, Schema>

MetadataType

MetadataType extends StreamDefinitionMetadataBase = StreamDefinitionMetadataBase

QueueInvokes

QueueInvokes extends QueueInvokeList = QueueInvokeList

AgentInvokes

AgentInvokes extends AgentInvokeList = AgentInvokeList

Properties

agentInvokes

agentInvokes: AgentInvokes

Defined in: core/types/stream/StreamDefinition.ts:54

---

aggregateChunks

aggregateChunks: boolean

Defined in: core/types/stream/StreamDefinition.ts:51

---

call

call: StreamFunction<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, ChunkType, FinalType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes, AgentInvokes>

Defined in: core/types/stream/StreamDefinition.ts:33

---

chunkSchema?

optional chunkSchema: Schema

Defined in: core/types/stream/StreamDefinition.ts:31

---

chunkValidationEnabled

chunkValidationEnabled: boolean

Defined in: core/types/stream/StreamDefinition.ts:49

---

emitList

emitList: EmitList

Defined in: core/types/stream/StreamDefinition.ts:55

---

eventBridgeConfig

eventBridgeConfig: DefinitionEventBridgeConfig

Defined in: core/types/stream/StreamDefinition.ts:30

---

finalEventName?

optional finalEventName: string

Defined in: core/types/stream/StreamDefinition.ts:48

---

finalSchema?

optional finalSchema: Schema

Defined in: core/types/stream/StreamDefinition.ts:32

---

finalValidationEnabled

finalValidationEnabled: boolean

Defined in: core/types/stream/StreamDefinition.ts:50

---

invokes

invokes: Invokes

Defined in: core/types/stream/StreamDefinition.ts:52

---

metadata

metadata: MetadataType

Defined in: core/types/stream/StreamDefinition.ts:29

---

queueInvokes

queueInvokes: QueueInvokes

Defined in: core/types/stream/StreamDefinition.ts:56

---

streamDescription

streamDescription: string

Defined in: core/types/stream/StreamDefinition.ts:28

---

streamInvokes

streamInvokes: StreamInvokes

Defined in: core/types/stream/StreamDefinition.ts:53

---

streamName

streamName: string

Defined in: core/types/stream/StreamDefinition.ts:27