Class S2Streams

Basin-scoped helper for listing and configuring streams.

Access via S2Basin.streams. Methods inherit the basin's retry configuration.

Index

Constructors

Methods

create delete getConfig list listAll reconfigure

Constructors

constructor

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

Methods

create

create(
args: CreateStreamInput,
options?: S2RequestOptions,
): Promise<CreateStreamResponse>
Create a stream.
Parameters
- args: CreateStreamInput
  Input for creating a stream.
  - Optionalconfig?: StreamConfig
    Stream configuration.
  - stream: string
    Stream name that is unique to the basin. It can be between 1 and 512 bytes in length.
- Optionaloptions: S2RequestOptions
Returns Promise<CreateStreamResponse>
- Defined in packages/streamstore/src/streams.ts:162

delete

delete(args: DeleteStreamInput, options?: S2RequestOptions): Promise<void>
Delete a stream.
Parameters
- args: DeleteStreamInput
  Input for deleting a stream.
  - stream: string
    Stream name.
- Optionaloptions: S2RequestOptions
Returns Promise<void>
- Defined in packages/streamstore/src/streams.ts:212

getConfig

getConfig(
args: GetStreamConfigInput,
options?: S2RequestOptions,
): Promise<StreamConfig>
Get stream configuration.
Parameters
- args: GetStreamConfigInput
  Input for getting stream configuration.
  - stream: string
    Stream name.
- Optionaloptions: S2RequestOptions
Returns Promise<StreamConfig>
- Defined in packages/streamstore/src/streams.ts:190

list

list(
args?: ListStreamsInput,
options?: S2RequestOptions,
): Promise<ListStreamsResponse>
List streams in the basin.
Parameters
- Optionalargs: ListStreamsInput
  Input for listing streams.
  - Optionallimit?: number
    Number of results, up to a maximum of 1000.
  - Optionalprefix?: string
    Filter to streams whose name begins with this prefix.
  - OptionalstartAfter?: string
    Filter to streams whose name lexicographically starts after this string.
- Optionaloptions: S2RequestOptions
Returns Promise<ListStreamsResponse>
- Defined in packages/streamstore/src/streams.ts:103

listAll

listAll(
args?: ListAllStreamsInput,
options?: S2RequestOptions,
): AsyncIterable<StreamInfo>
List all streams in the basin with automatic pagination. Returns a lazy async iterable that fetches pages as needed.
Parameters
- Optionalargs: ListAllStreamsInput
  Optional options: prefix to filter by name prefix, limit for max results per page, includeDeleted to include streams pending deletion
- Optionaloptions: S2RequestOptions
Returns AsyncIterable<StreamInfo>
Example
```
for await (const stream of basin.streams.listAll({ prefix: "events-" })) {
  console.log(stream.name);
}
```
- Defined in packages/streamstore/src/streams.ts:136

reconfigure

reconfigure(
args: ReconfigureStreamInput,
options?: S2RequestOptions,
): Promise<StreamConfig>
Reconfigure a stream.
Parameters
- args: ReconfigureStreamInput
  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:232