Class

org.scalajs.dom.experimental

ReadableStreamController

Related Doc: package experimental

Permalink

class ReadableStreamController[-T] extends Object

¶3.3 Class ReadableStreamController of whatwg spec

The ReadableStreamController constructor cannot be used directly; it only works on a ReadableStream that is in the middle of being constructed.

T

Type of the Chunks to be enqueued to the Stream

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

Instance Constructors

  1. new ReadableStreamController(stream: ReadableStream[T] = null)

    Permalink

    stream

    can be null

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close(): Unit

    Permalink

    The close method will close the controlled readable stream.

    The close method will close the controlled readable stream. Consumers will still be able to read any previously-enqueued chunks from the stream, but once those are read, the stream will become closed throws scala.scalajs.js.TypeError if this is not a readable controller

  7. def desiredSize: Int

    Permalink

    The desiredSize getter returns the desired size to fill the controlled stream’s internal queue.

    The desiredSize getter returns the desired size to fill the controlled stream’s internal queue. It can be negative, if the queue is over-full. An underlying source should use this information to determine when and how to apply backpressure.

    returns

    the size of the strem - no idea if this actually is an int

  8. def enqueue(chunk: Chunk[T]): UndefOr[Int]

    Permalink

    The enqueue method will enqueue a given chunk in the controlled readable stream.

    The enqueue method will enqueue a given chunk in the controlled readable stream.

    chunk

    throws scala.scalajs.js.RangeError if size is too big

    returns

    seems like its an undefOr[Int] of the size

  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def error(e: Any): Unit

    Permalink

    The error method will error the readable stream, making all future interactions with it fail with the given error e.

    The error method will error the readable stream, making all future interactions with it fail with the given error e.

    e

    : an error - can this be any type? throws scala.scalajs.js.TypeError

  12. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hasOwnProperty(v: String): Boolean

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

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

    Permalink
    Definition Classes
    Any
  17. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  18. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  21. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. def valueOf(): Any

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped