Class S2Stream

constructor

• new S2Stream(
      name: string,
      client: Client,
      transportConfig: TransportConfig,
      retryConfig?: RetryConfig,
  ): S2Stream

  Parameters

  • name: string
  • client: Client
  • transportConfig: TransportConfig
  • OptionalretryConfig: RetryConfig

  Returns S2Stream

Readonlyname

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Returns Promise<void>

append

• append(input: AppendInput, options?: S2RequestOptions): Promise<AppendAck>

  Append a batch of records to the stream.

  • Supports conditional appends via fencingToken and matchSeqNum in the input.
  • Returns the acknowledged range and the stream tail after the append.
  • A batch may contain both string and bytes records.
  • streamConfig in the input is applied only if the append auto-creates the stream.

  Use AppendInput.create to construct a validated AppendInput. For high-throughput sequential appends, use appendSession() instead.

  Parameters

  • input: AppendInput

    The append input containing records and optional conditions

  • Optionaloptions: S2RequestOptions

    Optional request options

  Returns Promise<AppendAck>

appendSession

• appendSession(
      sessionOptions?: AppendSessionOptions,
      requestOptions?: S2RequestOptions,
  ): Promise<AppendSession>

  Create an append session that guarantees ordering of submissions.

  Use this to coordinate high-throughput, sequential appends with backpressure. Records can be either string or bytes format - the format is specified in each record. sessionOptions.streamConfig is sent whenever the session connects and is applied only if the append auto-creates the stream.

  Parameters

  • OptionalsessionOptions: AppendSessionOptions

    Options that control append session behavior

  • OptionalrequestOptions: S2RequestOptions

    Optional request options

  Returns Promise<AppendSession>

checkTail

• checkTail(options?: S2RequestOptions): Promise<TailResponse>

  Check the tail of the stream.

  Returns the next sequence number and timestamp to be assigned (tail).

  Parameters

  • Optionaloptions: S2RequestOptions

  Returns Promise<TailResponse>

close

• close(): Promise<void>

  Returns Promise<void>

read

• read<Format extends "string" | "bytes" = "string">(
      input?: ReadInput,
      options?: S2RequestOptions & { as?: Format },
  ): Promise<ReadBatch<Format>>

  Read records from the stream.

  • When as: "bytes" is provided, bodies and headers are decoded from base64 to Uint8Array.
  • Supports starting position by seq_num, timestamp, or tail_offset and can clamp to the tail.
  • Non-streaming reads are bounded by count and bytes (defaults 1000 and 1 MiB).
  • When ignoreCommandRecords is set, command records are filtered from the single returned batch, which may then be empty. Use readSession to keep reading until data records are found.
  • streamConfig is applied only if the read auto-creates the stream.

  Type Parameters

  • Format extends "string" | "bytes" = "string"

  Parameters

  • Optionalinput: ReadInput
  • Optionaloptions: S2RequestOptions & { as?: Format }

  Returns Promise<ReadBatch<Format>>

readSession

• readSession<Format extends "string" | "bytes" = "string">(
      input?: ReadInput,
      options?: S2RequestOptions & { as?: Format },
  ): Promise<ReadSession<Format>>

  Open a streaming read session

  Use the returned session as an async iterable or as a readable stream. When as: "bytes" is provided, bodies and headers are decoded to Uint8Array. streamConfig is sent whenever the session connects and is applied only if the read auto-creates the stream.

  Type Parameters

  • Format extends "string" | "bytes" = "string"

  Parameters

  • Optionalinput: ReadInput
  • Optionaloptions: S2RequestOptions & { as?: Format }

  Returns Promise<ReadSession<Format>>

withEncryptionKey

• withEncryptionKey(encryptionKey: EncryptionKeyInput): S2Stream

  Return a new stream handle that sends the supplied encryption key on append/read requests.

  Parameters

  • encryptionKey: EncryptionKeyInput

  Returns S2Stream