Packages

class Readable extends Stream with ReadableStream

Annotations
@JSType() @JSImport("stream", "Readable") @native()
Linear Supertypes
ReadableStream, Stream, internal, ^, ^, EventEmitter, StObject, Object, Any, AnyRef, Any
Known Subclasses
IncomingMessage, Socket, Socket, Duplex, Readable, Duplex
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Readable
  2. ReadableStream
  3. Stream
  4. internal
  5. ^
  6. ^
  7. EventEmitter
  8. StObject
  9. Object
  10. Any
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Readable(opts: ReadableOptions)
  2. new Readable()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _destroy(error: Null, callback: Function1[UndefOr[|[Error, Null]], Unit]): Unit
  5. def _destroy(error: Error, callback: Function1[UndefOr[|[Error, Null]], Unit]): Unit
  6. def _read(size: Double): Unit
  7. def addListener(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  8. def addListener(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  9. def addListener_close(event: close, listener: Function0[Unit]): Readable.this.type

    Event emitter The defined events on documents including: 1.

    Event emitter The defined events on documents including: 1. close 2. data 3. end 4. error 5. pause 6. readable 7. resume

    Annotations
    @JSName("addListener")
  10. def addListener_data(event: data, listener: Function1[Any, Unit]): Readable.this.type
    Annotations
    @JSName("addListener")
  11. def addListener_end(event: end, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("addListener")
  12. def addListener_error(event: error, listener: Function1[Error, Unit]): Readable.this.type
    Annotations
    @JSName("addListener")
  13. def addListener_pause(event: pause, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("addListener")
  14. def addListener_readable(event: readable, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("addListener")
  15. def addListener_resume(event: resume, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("addListener")
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  18. def destroy(error: Error): Unit
  19. def destroy(): Unit
  20. var destroyed: Boolean
  21. def emit(event: Symbol, args: Any*): Boolean
    Definition Classes
    EventEmitter
  22. def emit(event: String, args: Any*): Boolean
    Definition Classes
    EventEmitter
  23. def emit_close(event: close): Boolean
    Annotations
    @JSName("emit")
  24. def emit_data(event: data, chunk: Any): Boolean
    Annotations
    @JSName("emit")
  25. def emit_end(event: end): Boolean
    Annotations
    @JSName("emit")
  26. def emit_error(event: error, err: Error): Boolean
    Annotations
    @JSName("emit")
  27. def emit_pause(event: pause): Boolean
    Annotations
    @JSName("emit")
  28. def emit_readable(event: readable): Boolean
    Annotations
    @JSName("emit")
  29. def emit_resume(event: resume): Boolean
    Annotations
    @JSName("emit")
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  32. def eventNames(): Array[|[String, Symbol]]
    Definition Classes
    EventEmitter
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def getMaxListeners(): Double
    Definition Classes
    EventEmitter
  35. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def isPaused(): Boolean
    Definition Classes
    ReadableStream
  39. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  40. def listenerCount(event: Symbol): Double
    Definition Classes
    EventEmitter
  41. def listenerCount(event: String): Double
    Definition Classes
    EventEmitter
  42. def listeners(event: Symbol): Array[Function]
    Definition Classes
    EventEmitter
  43. def listeners(event: String): Array[Function]
    Definition Classes
    EventEmitter
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. def off(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  48. def off(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  49. def on(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  50. def on(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  51. def on_close(event: close, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("on")
  52. def on_data(event: data, listener: Function1[Any, Unit]): Readable.this.type
    Annotations
    @JSName("on")
  53. def on_end(event: end, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("on")
  54. def on_error(event: error, listener: Function1[Error, Unit]): Readable.this.type
    Annotations
    @JSName("on")
  55. def on_pause(event: pause, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("on")
  56. def on_readable(event: readable, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("on")
  57. def on_resume(event: resume, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("on")
  58. def once(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  59. def once(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  60. def once_close(event: close, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("once")
  61. def once_data(event: data, listener: Function1[Any, Unit]): Readable.this.type
    Annotations
    @JSName("once")
  62. def once_end(event: end, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("once")
  63. def once_error(event: error, listener: Function1[Error, Unit]): Readable.this.type
    Annotations
    @JSName("once")
  64. def once_pause(event: pause, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("once")
  65. def once_readable(event: readable, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("once")
  66. def once_resume(event: resume, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("once")
  67. def pause(): Readable.this.type
    Definition Classes
    ReadableStream
  68. def pipe[T](destination: T, options: End): T
    Definition Classes
    Readable → ReadableStream → internal
  69. def pipe[T](destination: T): T
    Definition Classes
    Readable → ReadableStream → internal
  70. def prependListener(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  71. def prependListener(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  72. def prependListener_close(event: close, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  73. def prependListener_data(event: data, listener: Function1[Any, Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  74. def prependListener_end(event: end, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  75. def prependListener_error(event: error, listener: Function1[Error, Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  76. def prependListener_pause(event: pause, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  77. def prependListener_readable(event: readable, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  78. def prependListener_resume(event: resume, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependListener")
  79. def prependOnceListener(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  80. def prependOnceListener(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  81. def prependOnceListener_close(event: close, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  82. def prependOnceListener_data(event: data, listener: Function1[Any, Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  83. def prependOnceListener_end(event: end, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  84. def prependOnceListener_error(event: error, listener: Function1[Error, Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  85. def prependOnceListener_pause(event: pause, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  86. def prependOnceListener_readable(event: readable, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  87. def prependOnceListener_resume(event: resume, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("prependOnceListener")
  88. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  89. def push(chunk: Any, encoding: BufferEncoding): Boolean
  90. def push(chunk: Any): Boolean
  91. def rawListeners(event: Symbol): Array[Function]
    Definition Classes
    EventEmitter
  92. def rawListeners(event: String): Array[Function]
    Definition Classes
    EventEmitter
  93. def read(size: Double): |[String, Buffer]
    Definition Classes
    ReadableStream
  94. def read(): |[String, Buffer]
    Definition Classes
    ReadableStream
  95. val readable: Boolean
    Definition Classes
    ReadableStream
  96. val readableEncoding: |[BufferEncoding, Null]
  97. val readableEnded: Boolean
  98. val readableFlowing: |[Boolean, Null]
  99. val readableHighWaterMark: Double
  100. val readableLength: Double
  101. val readableObjectMode: Boolean
  102. def removeAllListeners(event: Symbol): Readable.this.type
    Definition Classes
    EventEmitter
  103. def removeAllListeners(event: String): Readable.this.type
    Definition Classes
    EventEmitter
  104. def removeAllListeners(): Readable.this.type
    Definition Classes
    EventEmitter
  105. def removeListener(event: Symbol, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  106. def removeListener(event: String, listener: Function1[Any, Unit]): Readable.this.type
    Definition Classes
    EventEmitter
  107. def removeListener_close(event: close, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  108. def removeListener_data(event: data, listener: Function1[Any, Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  109. def removeListener_end(event: end, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  110. def removeListener_error(event: error, listener: Function1[Error, Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  111. def removeListener_pause(event: pause, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  112. def removeListener_readable(event: readable, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  113. def removeListener_resume(event: resume, listener: Function0[Unit]): Readable.this.type
    Annotations
    @JSName("removeListener")
  114. def resume(): Readable.this.type
    Definition Classes
    ReadableStream
  115. def setEncoding(encoding: BufferEncoding): Readable.this.type
    Definition Classes
    ReadableStream
  116. def setMaxListeners(n: Double): Readable.this.type
    Definition Classes
    EventEmitter
  117. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  118. def toLocaleString(): String
    Definition Classes
    Object
  119. def toString(): String
    Definition Classes
    AnyRef → Any
  120. def unpipe(destination: WritableStream): Readable.this.type
    Definition Classes
    ReadableStream
  121. def unpipe(): Readable.this.type
    Definition Classes
    ReadableStream
  122. def unshift(chunk: Any, encoding: BufferEncoding): Unit
  123. def unshift(chunk: Any): Unit
  124. def unshift(chunk: Uint8Array, encoding: BufferEncoding): Unit
    Definition Classes
    ReadableStream
  125. def unshift(chunk: Uint8Array): Unit
    Definition Classes
    ReadableStream
  126. def unshift(chunk: String, encoding: BufferEncoding): Unit
    Definition Classes
    ReadableStream
  127. def unshift(chunk: String): Unit
    Definition Classes
    ReadableStream
  128. def valueOf(): Any
    Definition Classes
    Object
  129. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  130. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  132. def wrap(oldStream: ReadableStream): Readable.this.type
    Definition Classes
    ReadableStream

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ReadableStream

Inherited from Stream

Inherited from internal

Inherited from ^

Inherited from ^

Inherited from EventEmitter

Inherited from StObject

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped