Trait/Object

io.scalajs.npm.combinedstream

CombinedStream

Related Docs: object CombinedStream | package combinedstream

Permalink

trait CombinedStream extends Object with Readable

combined-stream - A stream that emits multiple other streams one after another.

Annotations
@RawJSType() @native()
Linear Supertypes
Readable, IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CombinedStream
  2. Readable
  3. IEventEmitter
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def _read(size: Int): Unit

    Permalink
    Definition Classes
    Readable
  5. var _read: Function

    Permalink
    Definition Classes
    Readable
  6. def _readableState: ReadableState

    Permalink
    Definition Classes
    Readable
  7. def addListener(eventName: String, listener: Function): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  8. def append(stream: |[String, Buffer]): Unit

    Permalink

    Appends the given stream to the combinedStream object.

    Appends the given stream to the combinedStream object. If pauseStreams is set to true, this stream will also be paused right away.

    streams can also be a function that takes one parameter called next. next is a function that must be invoked in order to provide the next stream, see example above.

    Regardless of how the stream is appended, combined-stream always attaches an 'error' listener to it, so you don't have to do that manually.

    Special case: stream can also be a String or Buffer.

    stream

    the given string or buffer

  9. def append(stream: Readable): Unit

    Permalink

    Appends the given stream to the combinedStream object.

    Appends the given stream to the combinedStream object. If pauseStreams is set to true, this stream will also be paused right away.

    streams can also be a function that takes one parameter called next. next is a function that must be invoked in order to provide the next stream, see example above.

    Regardless of how the stream is appended, combined-stream always attaches an 'error' listener to it, so you don't have to do that manually.

    Special case: stream can also be a String or Buffer.

    stream

    the given stream

  10. def append(callback: Function1[Function1[|[|[Readable, Buffer], String], Readable], Any]): Unit

    Permalink

    Appends the given stream to the combinedStream object.

    Appends the given stream to the combinedStream object. If pauseStreams is set to true, this stream will also be paused right away.

    streams can also be a function that takes one parameter called next. next is a function that must be invoked in order to provide the next stream, see example above.

    Regardless of how the stream is appended, combined-stream always attaches an 'error' listener to it, so you don't have to do that manually.

    Special case: stream can also be a String or Buffer.

    callback

    the given callback function

  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def dataSize: Int

    Permalink

    The amount of bytes (or characters) currently buffered by combinedStream.

  14. def destroy(): Unit

    Permalink

    Same as combinedStream.end(), except it emits a 'close' event instead of 'end'.

  15. var domain: String

    Permalink
    Definition Classes
    IEventEmitter
  16. def emit(name: String, args: Any*): Any

    Permalink
    Definition Classes
    IEventEmitter
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getMaxListeners(): Int

    Permalink
    Definition Classes
    IEventEmitter
  22. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def isPaused(): Boolean

    Permalink
    Definition Classes
    Readable
  26. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  27. def listenerCount(eventName: String): Int

    Permalink
    Definition Classes
    IEventEmitter
  28. def listeners(eventName: String): Array[Function]

    Permalink
    Definition Classes
    IEventEmitter
  29. def maxDataSize: Int

    Permalink

    The maximum amount of bytes (or characters) to buffer for all source streams.

    The maximum amount of bytes (or characters) to buffer for all source streams. If this value is exceeded, combinedStream emits an 'error' event.

  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def on(eventName: String, listener: Function): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  34. def once(eventName: String, listener: Function): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  35. def pause(): CombinedStream.this.type

    Permalink
    Definition Classes
    Readable
  36. def pauseStreams: Boolean

    Permalink

    Whether to apply back pressure to the underlying streams.

    Whether to apply back pressure to the underlying streams. If set to false, the underlying streams will never be paused. If set to true, the underlying streams will be paused right after being appended, as well as when delayedStream.pipe() wants to throttle.

  37. def pipe(destination: Writable, options: |[ReadablePipeOptions, RawOptions]): CombinedStream.this.type

    Permalink
    Definition Classes
    Readable
  38. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  39. def push(chunk: Buffer): Boolean

    Permalink
    Definition Classes
    Readable
  40. def push(chunk: String, encoding: String): Boolean

    Permalink
    Definition Classes
    Readable
  41. def read[T](size: Int): T

    Permalink
    Definition Classes
    Readable
  42. def removeAllListeners(): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  43. def removeAllListeners(eventName: String): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  44. def removeListener(eventName: String, listener: Function): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  45. def resume(): CombinedStream.this.type

    Permalink
    Definition Classes
    Readable
  46. def setEncoding(encoding: String): CombinedStream.this.type

    Permalink
    Definition Classes
    Readable
  47. def setMaxListeners(n: Int): CombinedStream.this.type

    Permalink
    Definition Classes
    IEventEmitter
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  49. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  50. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  51. def unpipe(destination: Writable): Unit

    Permalink
    Definition Classes
    Readable
  52. def unshift(chunk: Any): Unit

    Permalink
    Definition Classes
    Readable
  53. var usingDomains: Boolean

    Permalink
    Definition Classes
    IEventEmitter
  54. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  55. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def wrap(stream: Any): Unit

    Permalink
    Definition Classes
    Readable
  59. def write(data: Any): Unit

    Permalink

    You should not call this, combinedStream takes care of piping the appended streams into itself for you.

Inherited from Readable

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped