Options
All
  • Public
  • Public/Protected
  • All
Menu

A wrapper around a writable stream to implement AppendableBuffer. The stream must be explicitly closed by calling end after all bytes have been written.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly outStream

outStream: Writable

Private pauseCount

pauseCount: number

Private paused

Private writtenBytes

writtenBytes: number

Accessors

length

  • get length(): number

Methods

add

addAll

end

  • end(): void

pause

  • Pauses the writing process, i.e. bytes added are not written to the underlying output until resume is next called and can be cancelled from being written by calling reset.

    If called multiple times, resume and reset only act on bytes added since the most recent pause. Example:

    let gb = new GrowableBuffer
    gb
      .pause()
        .add(1).add(2).add(3)
        .pause()
          .add(4).add(5).add(6)
          .reset() //cancels [4, 5, 6]
        .resume()
      .resume() //resumes [1, 2, 3]
    console.log(new Uint8Array(gb.toBuffer())) //Uint8Array [ 1, 2, 3 ]
    

    Returns AppendableStream

reset

resume

Generated using TypeDoc