stream

Type Members

1. class Chunk extends Object

   

   Represents a chunk of data

   Represents a chunk of data

   Annotations

   @RawJSType() @ScalaJSDefined()

2. 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

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

3. class DuplexOptions extends Object

   

   Duplex Options

   Duplex Options

   Annotations

   @RawJSType() @ScalaJSDefined()

4. trait IDuplex extends Object with Readable with Writable

   

   Duplex Interface

   Duplex Interface

   Annotations

   @RawJSType() @native()

5. trait ITransform extends Object with IDuplex

   

   Transform Interface

   Transform Interface

   Annotations

   @RawJSType() @native()

6. trait 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

   @RawJSType() @native()

7. trait Readable extends Object with IEventEmitter

   

   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

   @RawJSType() @native()

   See also

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

8. class ReadablePipeOptions extends Object

   

   Readable Pipe Options

   Readable Pipe Options

   Annotations

   @RawJSType() @ScalaJSDefined()

9. trait ReadableState extends Object

   

   Readable State

   Readable State

   Annotations

   @RawJSType() @native()

10. class Transform extends Object with IDuplex

    

    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

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

11. trait Writable extends Object with IEventEmitter

    

    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

    @RawJSType() @native()