Skip to content

myrotvorets/buffer-stream

Repository files navigation

buffer-stream

Quality Gate Status Build and Test

Converts a Buffer into a Readable Stream.

Since version 1.1.0, it provides a helper to read the entire stream into a Buffer.

Since version 1.3.0, it provides a writable stream that stores the result in a buffer.

Usage

import { BufferStream, WritableBufferStream, streamToBuffer } from '@myrotvorets/buffer-stream';

// BufferStream
const buf = Buffer.from('123');
const stream = new BufferStream(buf);

// streamToBuffer
streamToBuffer(stream).then((buffer) => { /* ... */ })

// WritableBufferStream
const stream = new WritableBufferStream();
stream.write('something', (err) => {
    if (!err) {
        console.log(stream.toString());

        stream.clear(); // Clear the internal buffer
    }
});

await stream.writeP('something else');

See the test directory for usage examples.