PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / StreamDefinition

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

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

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

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

Properties ​

aggregateChunks ​

aggregateChunks: boolean

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

call ​

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

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:81

emitList ​

emitList: EmitList

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

eventBridgeConfig ​

eventBridgeConfig: DefinitionEventBridgeConfig

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

finalEventName? ​

optional finalEventName?: string

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

finalSchema? ​

optional finalSchema?: Schema

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

finalValidationEnabled ​

finalValidationEnabled: boolean

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

hooks ​

hooks: object

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

afterGuard? ​

optional afterGuard?: Record<string, StreamAfterGuardHook<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, FinalType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>>

beforeGuard? ​

optional beforeGuard?: Record<string, StreamBeforeGuardHook<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>>

invokes ​

invokes: Invokes

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

metadata ​

metadata: MetadataType

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

queueInvokes ​

queueInvokes: QueueInvokes

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

streamDescription ​

streamDescription: string

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

streamInvokes ​

streamInvokes: StreamInvokes

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

streamName ​

streamName: string

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