fs2-io/fs2.internal.jsdeps.node/streamMod/Readable

Readable

@JSImport("stream", "Readable") @native @JSType class Readable() extends StObject with ReadableStream
Companion
object
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Constructors

def this(opts: ReadableOptions)

Concrete methods

def _destroy(error: Error, callback: Function1[UndefOr[Error | Null], Unit]): Unit
def _destroy(error: Null, callback: Function1[UndefOr[Error | Null], Unit]): Unit
def _read(size: Double): Unit
@JSName("addListener")
def addListener_close(event: close, listener: Function0[Unit]): Readable

Event emitter The defined events on documents including:

Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. error
  5. pause
  6. readable
  7. resume
@JSName("addListener")
def addListener_data(event: data, listener: Function1[Any, Unit]): Readable
@JSName("addListener")
def addListener_end(event: end, listener: Function0[Unit]): Readable
@JSName("addListener")
def addListener_error(event: error, listener: Function1[Error, Unit]): Readable
@JSName("addListener")
def addListener_pause(event: pause, listener: Function0[Unit]): Readable
@JSName("addListener")
def addListener_readable(event: readable, listener: Function0[Unit]): Readable
@JSName("addListener")
def addListener_resume(event: resume, listener: Function0[Unit]): Readable
def destroy(): Unit
def destroy(error: Error): Unit
@JSName("emit")
def emit_close(event: close): Boolean
@JSName("emit")
def emit_data(event: data, chunk: Any): Boolean
@JSName("emit")
def emit_end(event: end): Boolean
@JSName("emit")
def emit_error(event: error, err: Error): Boolean
@JSName("emit")
def emit_pause(event: pause): Boolean
@JSName("emit")
def emit_readable(event: readable): Boolean
@JSName("emit")
def emit_resume(event: resume): Boolean
@JSName("on")
def on_close(event: close, listener: Function0[Unit]): Readable
@JSName("on")
def on_data(event: data, listener: Function1[Any, Unit]): Readable
@JSName("on")
def on_end(event: end, listener: Function0[Unit]): Readable
@JSName("on")
def on_error(event: error, listener: Function1[Error, Unit]): Readable
@JSName("on")
def on_pause(event: pause, listener: Function0[Unit]): Readable
@JSName("on")
def on_readable(event: readable, listener: Function0[Unit]): Readable
@JSName("on")
def on_resume(event: resume, listener: Function0[Unit]): Readable
@JSName("once")
def once_close(event: close, listener: Function0[Unit]): Readable
@JSName("once")
def once_data(event: data, listener: Function1[Any, Unit]): Readable
@JSName("once")
def once_end(event: end, listener: Function0[Unit]): Readable
@JSName("once")
def once_error(event: error, listener: Function1[Error, Unit]): Readable
@JSName("once")
def once_pause(event: pause, listener: Function0[Unit]): Readable
@JSName("once")
def once_readable(event: readable, listener: Function0[Unit]): Readable
@JSName("once")
def once_resume(event: resume, listener: Function0[Unit]): Readable
@JSName("prependListener")
def prependListener_close(event: close, listener: Function0[Unit]): Readable
@JSName("prependListener")
def prependListener_data(event: data, listener: Function1[Any, Unit]): Readable
@JSName("prependListener")
def prependListener_end(event: end, listener: Function0[Unit]): Readable
@JSName("prependListener")
def prependListener_error(event: error, listener: Function1[Error, Unit]): Readable
@JSName("prependListener")
def prependListener_pause(event: pause, listener: Function0[Unit]): Readable
@JSName("prependListener")
def prependListener_readable(event: readable, listener: Function0[Unit]): Readable
@JSName("prependListener")
def prependListener_resume(event: resume, listener: Function0[Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_close(event: close, listener: Function0[Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_data(event: data, listener: Function1[Any, Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_end(event: end, listener: Function0[Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_error(event: error, listener: Function1[Error, Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_pause(event: pause, listener: Function0[Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_readable(event: readable, listener: Function0[Unit]): Readable
@JSName("prependOnceListener")
def prependOnceListener_resume(event: resume, listener: Function0[Unit]): Readable
def push(chunk: Any): Boolean
def push(chunk: Any, encoding: BufferEncoding): Boolean
@JSName("removeListener")
def removeListener_close(event: close, listener: Function0[Unit]): Readable
@JSName("removeListener")
def removeListener_data(event: data, listener: Function1[Any, Unit]): Readable
@JSName("removeListener")
def removeListener_end(event: end, listener: Function0[Unit]): Readable
@JSName("removeListener")
def removeListener_error(event: error, listener: Function1[Error, Unit]): Readable
@JSName("removeListener")
def removeListener_pause(event: pause, listener: Function0[Unit]): Readable
@JSName("removeListener")
def removeListener_readable(event: readable, listener: Function0[Unit]): Readable
@JSName("removeListener")
def removeListener_resume(event: resume, listener: Function0[Unit]): Readable
def unshift(chunk: Any): Unit
def unshift(chunk: Any, encoding: BufferEncoding): Unit

Inherited methods

def addListener(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def addListener(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def emit(event: Symbol, args: Any*): Boolean
Inherited from
EventEmitter
def emit(event: String, args: Any*): Boolean
Inherited from
EventEmitter
def eventNames(): Array[String | Symbol]
Inherited from
EventEmitter
def getMaxListeners(): Double
Inherited from
EventEmitter
def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPaused(): Boolean
Inherited from
ReadableStream
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def listenerCount(event: Symbol): Double
Inherited from
EventEmitter
def listenerCount(event: String): Double
Inherited from
EventEmitter
def listeners(event: Symbol): Array[Function]
Inherited from
EventEmitter
def listeners(event: String): Array[Function]
Inherited from
EventEmitter
def off(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def off(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def on(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def on(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def once(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def once(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def pause(): Readable
Inherited from
ReadableStream
def pipe[T](destination: T, options: End): T
Inherited from
ReadableStream
def pipe[T](destination: T): T
Inherited from
ReadableStream
def prependListener(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def prependListener(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def prependOnceListener(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def prependOnceListener(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def rawListeners(event: Symbol): Array[Function]
Inherited from
EventEmitter
def rawListeners(event: String): Array[Function]
Inherited from
EventEmitter
def read(size: Double): String | Buffer
Inherited from
ReadableStream
def read(): String | Buffer
Inherited from
ReadableStream
def removeAllListeners(event: Symbol): Readable
Inherited from
EventEmitter
def removeAllListeners(event: String): Readable
Inherited from
EventEmitter
def removeListener(event: Symbol, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def removeListener(event: String, listener: Function1[Any, Unit]): Readable
Inherited from
EventEmitter
def resume(): Readable
Inherited from
ReadableStream
def setEncoding(encoding: BufferEncoding): Readable
Inherited from
ReadableStream
def setMaxListeners(n: Double): Readable
Inherited from
EventEmitter
def toLocaleString(): String
Inherited from
Object
def unpipe(destination: WritableStream): Readable
Inherited from
ReadableStream
def unpipe(): Readable
Inherited from
ReadableStream
def unshift(chunk: Uint8Array, encoding: BufferEncoding): Unit
Inherited from
ReadableStream
def unshift(chunk: Uint8Array): Unit
Inherited from
ReadableStream
def unshift(chunk: String, encoding: BufferEncoding): Unit
Inherited from
ReadableStream
def unshift(chunk: String): Unit
Inherited from
ReadableStream
def valueOf(): Any
Inherited from
Object
def wrap(oldStream: ReadableStream): Readable
Inherited from
ReadableStream

Concrete fields

var _construct: UndefOr[Function1[Function1[UndefOr[Error | Null], Unit], Unit]]
var destroyed: Boolean
val readableEnded: Boolean
val readableFlowing: Boolean | Null
val readableLength: Double
val readableObjectMode: Boolean

Inherited fields

var readable: Boolean
Inherited from
ReadableStream