A lightweight object stream library for NodeJS and the browser.
var stream = ; var stream = ;stream; // validstream; // invalidstream; var readable = name: "obj" ;readable;
writable stream.writable()
creates a new writable stream
var writable = stream;
writable.write(object)
Writes a new object
writable;
writable.end([object])
Ends the stream
writable;writable;writable; // done
writable.once(event, callback)
listens to one event then disposes
reader writable.reader
Returns the readable object var writer = stream;var reader = writerreader; reader; reader; writer; // write & end
reader stream.readable()
creates a new readable object
reader.on(event, callback)
listens for an event.
event
error
- emitted on errordata
- emitted on dataend
- emitted when the stream closesdrain
- emitted when the writer is resumed
reader.once(event, callback)
listens to one event then disposes
reader.removeListener(event, callback)
removes a listener
reader.pause()
pauses the stream.
var writer = stream;var reader = writerreader; reader;writer; // buffered, doesn't get emitted as data
reader.resume()
resumes the stream.
reader.isPaused()
returns true if the stream is paused.
writable.pipe(writable)
pipes data to a writable
stream stream.through(fn)
helper for transforming data
var writable = stream;writablereader; writable;writable;