Function autoReadStream

  • autoReadStream<ST>(stream, cbs): (() => void)

  • 自动读取流并处理每个数据块。

    Type Parameters

    • ST extends ReadableStream<any>

      可读流的类型。

    Parameters

    • stream: ST

      要读取的流。

    • cbs: {
          onChunk: ST extends ReadableStream<DT>
              ? ((chunk) => Promise<void>)
              : never;
          onDone: (() => void);
      }

      回调函数对象。

      • onChunk: ST extends ReadableStream<DT>
            ? ((chunk) => Promise<void>)
            : never

        当读取到新的数据块时调用的函数。该函数接收一个参数，即数据块，并返回一个 Promise。

      • onDone: (() => void)

        当读取完所有数据块时调用的函数。

          • (): void

          • Returns void

    Returns (() => void)

    • 返回一个函数，调用该函数可以停止读取流。
      • (): void

      • Returns void

    Example

    const stream = getSomeReadableStream();
    const onChunk = async (chunk) => {
      console.log('New chunk:', chunk);
    };
    const onDone = () => {
      console.log('Done reading stream');
    };
    const stopReading = autoReadStream(stream, { onChunk, onDone });
    // Later...
    stopReading();

Settings

Member Visibility

Theme