Skip to content

PURISTA API


PURISTA API / @purista/core / StreamFramePayload

Type Alias: StreamFramePayload<Chunk, Final>

StreamFramePayload<Chunk, Final> = object

Defined in: core/types/stream/StreamFrame.ts:9

Type Parameters

Chunk

Chunk = unknown

Final

Final = unknown

Properties

chunk?

optional chunk: Chunk

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


error?

optional error: StreamErrorPayload

Defined in: core/types/stream/StreamFrame.ts:14


final?

optional final: Final

Defined in: core/types/stream/StreamFrame.ts:13


frameType

frameType: Exclude<StreamFrameType, "open">

Defined in: core/types/stream/StreamFrame.ts:10


reason?

optional reason: string

Defined in: core/types/stream/StreamFrame.ts:15


sequence

sequence: number

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