Class S2Streams

Stream management helper and argument types.

Index

Constructors

Methods

create delete getConfig list reconfigure

Constructors

constructor

new S2Streams(client: Client, retryConfig?: RetryConfig): S2Streams
Parameters
- client: Client
- OptionalretryConfig: RetryConfig
Returns S2Streams
- Defined in packages/streamstore/src/streams.ts:34

Methods

create

create(args: CreateStreamArgs, options?: S2RequestOptions): Promise<StreamInfo>
Create a stream.
Parameters
- args: CreateStreamArgs
- Optionaloptions: S2RequestOptions
Returns Promise<StreamInfo>
- Defined in packages/streamstore/src/streams.ts:67

delete

delete(args: DeleteStreamArgs, options?: S2RequestOptions): Promise<void>
Delete a stream.
Parameters
- args: DeleteStreamArgs
- Optionaloptions: S2RequestOptions
Returns Promise<void>
- Defined in packages/streamstore/src/streams.ts:107

getConfig

getConfig(
args: GetStreamConfigArgs,
options?: S2RequestOptions,
): Promise<StreamConfig>
Get stream configuration.
Parameters
- args: GetStreamConfigArgs
- Optionaloptions: S2RequestOptions
Returns Promise<StreamConfig>
- Defined in packages/streamstore/src/streams.ts:87

list

list(
args?: ListStreamsArgs,
options?: S2RequestOptions,
): Promise<ListStreamsResponse>
List streams in the basin.
Parameters
- Optionalargs: ListStreamsArgs
- Optionaloptions: S2RequestOptions
Returns Promise<ListStreamsResponse>
- Defined in packages/streamstore/src/streams.ts:46

reconfigure

reconfigure(
args: ReconfigureStreamArgs,
options?: S2RequestOptions,
): Promise<StreamConfig>
Reconfigure a stream.
Parameters
- args: ReconfigureStreamArgs
  Configuration for the stream to reconfigure (including stream name and fields to change)
- Optionaloptions: S2RequestOptions
Returns Promise<StreamConfig>
- Defined in packages/streamstore/src/streams.ts:127