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

append

• append(
      records: AppendRecordType | AppendRecordType[],
      args?: Omit<AppendArgs, "records">,
      options?: S2RequestOptions,
  ): Promise<AppendAck>

  Append one or more records to the stream.

  • Automatically base64-encodes when format is "bytes".
  • Supports conditional appends via fencing_token and match_seq_num.
  • Returns the acknowledged range and the stream tail after the append.

  All records in a single append call must use the same format (either all string or all bytes). For high-throughput sequential appends, use appendSession() instead.

  Parameters

  • records: AppendRecordType | AppendRecordType[]

    The record(s) to append

  • Optionalargs: Omit<AppendArgs, "records">

    Optional append arguments (fencing_token, match_seq_num)

  • 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.

  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>

read

• read<Format extends "string" | "bytes" = "string">(
      args?: ReadArgs<Format>,
      options?: S2RequestOptions,
  ): 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).
  • Use readSession for streaming reads

  Type Parameters

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

  Parameters

  • Optionalargs: ReadArgs<Format>
  • Optionaloptions: S2RequestOptions

  Returns Promise<ReadBatch<Format>>

readSession

• readSession<Format extends "string" | "bytes" = "string">(
      args?: ReadArgs<Format>,
      options?: S2RequestOptions,
  ): 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.

  Type Parameters

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

  Parameters

  • Optionalargs: ReadArgs<Format>
  • Optionaloptions: S2RequestOptions

  Returns Promise<ReadSession<Format>>