@s2-dev/streamstore - v0.24.1
    Preparing search index...

    Interface AcksStream

    Stream of append acknowledgements used by AppendSession.

    interface AcksStream {
        locked: boolean;
        "[asyncIterator]"(): AsyncIterator<AppendAck, any, any>;
        cancel(reason?: any): Promise<void>;
        getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
        getReader(): ReadableStreamDefaultReader<AppendAck>;
        getReader(
            options?: ReadableStreamGetReaderOptions,
        ): ReadableStreamReader<AppendAck>;
        pipeThrough<T>(
            transform: ReadableWritablePair<T, AppendAck>,
            options?: StreamPipeOptions,
        ): ReadableStream<T>;
        pipeTo(
            destination: WritableStream<AppendAck>,
            options?: StreamPipeOptions,
        ): Promise<void>;
        tee(): [ReadableStream<AppendAck>, ReadableStream<AppendAck>];
    }

    Hierarchy

    Index

    Properties

    locked

    Methods

    [asyncIterator] cancel getReader pipeThrough pipeTo tee

    Properties

    locked: boolean

    The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.

    MDN Reference

    Methods

    • Returns AsyncIterator<AppendAck, any, any>

    • The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

      MDN Reference

      Parameters

      • Optionalreason: any

      Returns Promise<void>

    • The getReader() method of the ReadableStream interface creates a reader and locks the stream to it.

      MDN Reference

      Parameters

      • options: { mode: "byob" }

      Returns ReadableStreamBYOBReader

    • Returns ReadableStreamDefaultReader<AppendAck>

    • Parameters

      • Optionaloptions: ReadableStreamGetReaderOptions

      Returns ReadableStreamReader<AppendAck>

    • The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

      MDN Reference

      Type Parameters

      • T

      Parameters

      • transform: ReadableWritablePair<T, AppendAck>
      • Optionaloptions: StreamPipeOptions

      Returns ReadableStream<T>

    • The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

      MDN Reference

      Parameters

      • destination: WritableStream<AppendAck>
      • Optionaloptions: StreamPipeOptions

      Returns Promise<void>

    • The tee() method of the two-element array containing the two resulting branches as new ReadableStream instances.

      MDN Reference

      Returns [ReadableStream<AppendAck>, ReadableStream<AppendAck>]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods