Class S2

Top-level S2 SDK client.

Authenticates with an access token and exposes account-scoped helpers for basins, streams, access tokens and metrics.

Index

Constructors

Properties

accessTokens basins metrics

Methods

Constructors

constructor

new S2(options: S2ClientOptions): S2
Create a new S2 client.
Parameters
- options: S2ClientOptions
  Access token configuration.
Returns S2
- Defined in packages/streamstore/src/s2.ts:49

Properties

`Readonly`accessTokens

accessTokens: S2AccessTokens

Manage access tokens for the account (list, issue, revoke).

`Readonly`basins

basins: S2Basins

Account-scoped basin management operations.

List, create, delete and reconfigure basins.

`Readonly`metrics

metrics: S2Metrics

Account, basin and stream level metrics.

Methods

basin

basin(name: string): S2Basin
Create a basin-scoped client bound to a specific basin name.
Parameters
- name: string
  Basin name (8-48 characters, lowercase alphanumeric and hyphens, no leading/trailing hyphens).
Returns S2Basin
Throws
If the basin name is invalid.
- Defined in packages/streamstore/src/s2.ts:92