Skip to content

DavidCai1111/readable-buffer-stream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

readable-buffer-stream

js-standard-style Build Status Coverage Status

Create readable stream which stores data in Buffer.

Installation

npm install readable-buffer-stream

Usage

'use strict'
const BufferStream = require('readable-buffer-stream')

let bufferStream = new BufferStream()

bufferStream.on('data', (data) => {
  console.log(Buffer.isBuffer(data)) // true
})

bufferStream.put(new Buffer('buffer'))
bufferStream.put(new Buffer('another buffer'))

API

BufferStream({initialSize, chunkSize, incrementSize})

  • initialSize: Number initial size of inner buffer.
  • chunkSize: Number size of data in each data event.
  • incrementSize: Number size to increase when inner buffer do not have enough size.

Create a instance of BufferStream, which extends stream.Readable.

bufferStream.put(chunk)

  • buffer: Buffer data to be put in the bufferStream.

Put chunk in the inner buffer.

bufferStream.stop()

Stop the bufferStream.

About

🚚Create readable stream which stores data in Buffer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published