prorm API Reference
    Preparing search index...

    Class StreamIterator<T>

    Transform stream that converts a readable stream into an async iterator Allows using stream.pipe(new StreamIterator()) and then for await...of

    Type Parameters

    • T = any

    Hierarchy

    • Transform
      • StreamIterator
    Index
    constructor
    _transform _flush [asyncIterator]

    _transform

    • _transform(
          chunk: T,
          encoding: string,
          callback: (error?: Error | null, data?: T) => void,
      ): void

      Transform a chunk

      Parameters

      • chunk: T
      • encoding: string
      • callback: (error?: Error | null, data?: T) => void

      Returns void

    _flush

    • _flush(callback: (error?: Error | null, data?: T) => void): void

      Handle stream end

      Parameters

      • callback: (error?: Error | null, data?: T) => void

      Returns void

    • Create async iterator from this transform stream

      Returns AsyncIterator<any, any, unknown>

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods