Buffers events from a stream until you are ready to handle them.
npm install delayed-stream
The following example shows how to write a http echo server that delays its response by 1000 ms.
var DelayedStream = ;var http = ;http;
If you are not using
Stream#pipe, you can also manually release the buffered
events by calling
var delayed = DelayedStream;;
In order to use this meta stream properly, here are a few things you should know about the implementation.
Event Buffering / Proxying
All events of the
source stream are hijacked by overwriting the
method. Until node implements a catch-all event listener, this is the only way.
However, delayed-stream still continues to emit all events it captures on the
source, regardless of whether you have released the delayed stream yet or
Upon creation, delayed-stream captures all
source events and stores them in
an internal event buffer. Once
delayedStream.release() is called, all
buffered events are emitted on the
delayedStream, and the event buffer is
cleared. After that, delayed-stream merely acts as a proxy for the underlaying
Error events on
source are buffered / proxied just like any other events.
delayedStream.create attaches a no-op
'error' listener to the
source. This way you only have to handle errors on the
object, rather than in two places.
delayed-stream provides a
maxDataSize property that can be used to limit
the amount of data being buffered. In order to protect you from bad
streams that don't react to
source.pause(), this feature is enabled by
Returns a new
delayedStream. Available options are:
The description for those properties can be found below.
source stream managed by this object. This is useful if you are
delayedStream around, and you still want to access properties
delayedStream.pauseStream = true
Whether to pause the underlaying
source when calling
DelayedStream.create(). Modifying this property afterwards has no effect.
delayedStream.maxDataSize = 1024 * 1024
The amount of data to buffer before emitting an
If the underlaying source is emitting
Buffer objects, the
refers to bytes.
If you know what you are doing, you can set this property to
disable this feature. You can also modify this property during runtime.
delayedStream.dataSize = 0
The amount of data buffered so far.
An ECMA5 getter that returns the value of
delayedStream has not been released so far,
In either case,
source.resume() is called.
delayedStream.resume() and then proxies the arguments to
Emits and clears all events that have been buffered up so far. This does not
resume the underlaying source, use
delayed-stream is licensed under the MIT license.