streamify-string
v1.0.1
Published
Accepts a string and returns a readable stream that outputs the string.
Downloads
18,369
Readme
streamify-string
streamify-string
accepts a string
and returns a Readable stream that
outputs the string. It's useful for stubbing Readable streams when writing
unit-tests for Writeable, Duplex, and Transform streams.
const Streamify = require('streamify-string');
const myWritableStream = require('../path/to/file.js');
// initialize a string
var str = 'Grumpy wizards make toxic brew for the evil Queen and Jack.'
// "Streamify" that string and pipe it to a writeable stream
Streamify(str).pipe(myWriteableStream);
Parameters
const streamified = Streamify(str, [options]);
str
: thestring
that the stream should output.options
: Optional options to pass to the stream constructor. (Documentation)
Events
The stream will emit the following events: