Interface StreamManager

Interface for managing streaming actions, allowing creation and subscription to streams. Implementations can provide different storage backends (e.g., in-memory, database, cache).

interface StreamManager {
    open<S, O>(streamId: string): Promise<ActionStreamInput<S, O>>;
    subscribe<S, O>(
        streamId: string,
        options: ActionStreamSubscriber<S, O>,
    ): Promise<{ unsubscribe: () => void }>;
}

Implemented by

InMemoryStreamManager

Index

Methods

open subscribe

Methods

open

open<S, O>(streamId: string): Promise<ActionStreamInput<S, O>>
Opens a stream for writing.
Type Parameters
- S
- O
Parameters
- streamId: string
  The unique identifier for the stream.
Returns Promise<ActionStreamInput<S, O>>
An object to write to the stream.
- Defined in core/lib/action-D-zq6SnX.d.ts:562

subscribe<S, O>(
streamId: string,
options: ActionStreamSubscriber<S, O>,
): Promise<{ unsubscribe: () => void }>
Subscribes to a stream to receive its events.
Type Parameters
- S
- O
Parameters
- streamId: string
  The unique identifier for the stream.
- options: ActionStreamSubscriber<S, O>
  The subscriber callbacks.
Returns Promise<{ unsubscribe: () => void }>
A promise resolving to an object containing an unsubscribe function.
- Defined in core/lib/action-D-zq6SnX.d.ts:569

Interface StreamManager

Implemented by

Index

Methods

Methods

open

Type Parameters

Parameters

Returns Promise<ActionStreamInput<S, O>>

Type Parameters

Parameters

Returns Promise<{ unsubscribe: () => void }>

Settings

On This Page