Type Members

1.  class Duplex extends Object with IDuplex

   A "duplex" stream is one that is both Readable and Writable, such as a TCP socket connection.

   A "duplex" stream is one that is both Readable and Writable, such as a TCP socket connection.

   Note that stream.Duplex is an abstract class designed to be extended with an underlying implementation of the stream._read(size) and stream._write(chunk, encoding, callback) methods as you would with a Readable or Writable stream class.

   Since JavaScript doesn't have multiple prototypal inheritance, this class prototypally inherits from Readable, and then parasitically from Writable. It is thus up to the user to implement both the low-level stream._read(n) method as well as the low-level stream._write(chunk, encoding, callback) method on extension duplex classes.

   Annotations

   @JSType() @native() @JSImport("stream", "Duplex")

2.  trait DuplexOptions extends Object

   Annotations

   @JSType()

3.  type ErrorCallback = Function1[Error, Any]
4.  trait FinishedOptions extends Object

   Annotations

   @JSType()

5.  sealed trait IDuplex extends Object with IReadable with IWritable

   Duplex Interface

   Duplex Interface

   Annotations

   @JSType() @native()

6.  sealed trait IReadable extends Object with Stream with LegacyStream

   The Readable stream interface is the abstraction for a source of data that you are reading from.

   The Readable stream interface is the abstraction for a source of data that you are reading from. In other words, data comes out of a Readable stream.

   Annotations

   @JSType() @native()

   See also

   https://nodejs.org/api/stream.html#stream_readable_streams

7.  sealed trait ITransform extends Object with IDuplex

   Annotations

   @JSType() @native()

8.  sealed trait IWritable extends Object with Stream with LegacyStream

   The Writable stream interface is an abstraction for a destination that you are writing data to.

   The Writable stream interface is an abstraction for a destination that you are writing data to.

   Annotations

   @JSType() @native()

9.  trait LegacyStream extends Object with IEventEmitter

   Annotations

   @JSType() @native()

10.  class PassThrough extends Transform

    This is a trivial implementation of a Transform stream that simply passes the input bytes across to the output.

    This is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is mainly for examples and testing, but there are occasionally use cases where it can come in handy as a building block for novel sorts of streams.

    Annotations

    @JSType() @native() @JSImport("stream", "PassThrough")

11.  class Readable extends Object with IReadable

    Custom Readable streams must call the new stream.Readable([options]) constructor and implement the readable._read() method.

    Custom Readable streams must call the new stream.Readable([options]) constructor and implement the readable._read() method. https://nodejs.org/api/stream.html#stream_implementing_a_readable_stream

    Annotations

    @JSType() @native() @JSImport("stream", "Readable")

12.  implicit final class ReadableExtensions[R <: IReadable] extends AnyVal
13.  trait ReadableOptions extends Object

    Annotations

    @JSType()

14.  trait ReadablePipeOptions extends Object

    Annotations

    @JSType()

15.  trait ReadableState extends Object

    Readable State

    Readable State

    Annotations

    @JSType() @native()

16.  trait Stream extends Object

    Marker trait as parent of both Readable and Writable.

    Marker trait as parent of both Readable and Writable.

    Annotations

    @JSType() @native()

17.  implicit final class StreamModuleExtensions extends AnyVal
18.  class Transform extends Object with ITransform

    Transform streams are Duplex streams where the output is in some way computed from the input.

    Transform streams are Duplex streams where the output is in some way computed from the input. They implement both the Readable and Writable interfaces.

    Annotations

    @JSType() @native() @JSImport("stream", "Transform")

19.  trait TransformOptions extends Object

    Annotations

    @JSType()

20.  type Wait = Function0[Promise[Unit]]
21.  class Writable extends Object with IWritable

    Custom Writable streams must call the new stream.Writable([options]) constructor and pass the writable._write() and/or writable._writev() method implementations via options.

    Custom Writable streams must call the new stream.Writable([options]) constructor and pass the writable._write() and/or writable._writev() method implementations via options. https://nodejs.org/api/stream.html#stream_implementing_a_writable_stream

    Annotations

    @JSType() @native() @JSImport("stream", "Writable")

22.  implicit final class WritableExtensions[W <: IWritable] extends AnyVal
23.  trait WritableOptions extends Object

    Annotations

    @JSType()