enum abstract ReadableEvent<T>(Event<T>)
package js.node.stream
to Event<T>
import js.node.stream.Readable
Readable streams are an abstraction for a source from which data is consumed.
See also:
Variables
inlineread onlyClose:ReadableEvent<() ‑> Void> = "close"
The 'close'
event is emitted when the stream and any of its underlying
resources (a file descriptor, for example) have been closed.
The event indicates that no more events will be emitted, and no further computation will occur.
See also:
inlineread onlyData:ReadableEvent<Dynamic ‑> Void> = "data"
The 'data'
event is emitted whenever the stream is relinquishing ownership of
a chunk of data to a consumer. This may occur whenever the stream is switched
in flowing mode by calling readable.pipe()
, readable.resume()
, or by
attaching a listener callback to the 'data'
event. The 'data'
event will
also be emitted whenever the readable.read()
method is called and a chunk of
data is available to be returned.
See also:
inlineread onlyEnd:ReadableEvent<() ‑> Void> = "end"
The 'end'
event is emitted when there is no more data to be consumed from
the stream.
See also:
inlineread onlyError:ReadableEvent<Error ‑> Void> = "error"
The 'error'
event may be emitted by a Readable
implementation at any time.
Typically, this may occur if the underlying stream is unable to generate data
due to an underlying internal failure, or when a stream implementation attempts
to push an invalid chunk of data.
See also:
inlineread onlyPause:ReadableEvent<() ‑> Void> = "pause"
The 'pause'
event is emitted when stream.pause()
is called
and readableFlowing
is not false
.
See also:
inlineread onlyReadable:ReadableEvent<() ‑> Void> = "readable"
The 'readable'
event is emitted when there is data available to be read from
the stream. In some cases, attaching a listener for the 'readable'
event will
cause some amount of data to be read into an internal buffer.
See also:
inlineread onlyResume:ReadableEvent<() ‑> Void> = "resume"
The 'resume'
event is emitted when stream.resume()
is
called and readableFlowing
is not true
.
See also: