trait WriteableStream[-T] extends Object
¶4.2. Class WritableStream of whatwg Stream spec
todo: the constructor
- T
Type of the Chunks to be written to the Stream
- Annotations
- @JSType() @native()
- Alphabetic
- By Inheritance
- WriteableStream
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
abort(reason: Any): Unit
The abort method signals that the producer can no longer successfully write to the stream and it should be immediately moved to an "errored" state, with any queued-up writes discarded.
The abort method signals that the producer can no longer successfully write to the stream and it should be immediately moved to an "errored" state, with any queued-up writes discarded. This will also execute any abort mechanism of the underlying sink. see ¶4.2.4.4. abort(reason)
- reason
spec specifies Any (!?)
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
close(): Promise[WriteableStream[T]]
The close method signals that the producer is done writing chunks to the stream and wishes to move the stream to a "closed" state.
The close method signals that the producer is done writing chunks to the stream and wishes to move the stream to a "closed" state. This queues an action to close the stream, such that once any currently queued-up writes complete, the close mechanism of the underlying sink will execute, releasing any held resources. In the meantime, the stream will be in a "closing" state.
- returns
a promise of this stream being closed
-
val
closed: Promise[WriteableStream[T]]
The closed getter returns a promise that will be fulfilled when the stream becomes closed, or rejected if it ever errors.
The closed getter returns a promise that will be fulfilled when the stream becomes closed, or rejected if it ever errors. see ¶4.2.4.1. get closed
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
ready: Promise[WriteableStream[T]]
The ready getter returns a promise that will be fulfilled when the stream transitions away from the "waiting" state to any other state.
The ready getter returns a promise that will be fulfilled when the stream transitions away from the "waiting" state to any other state. Once the stream transitions back to "waiting", the getter will return a new promise that stays pending until the next state transition. In essence, this promise gives a signal as to when any backpressure has let up (or that the stream has been closed or errored).
see ¶4.2.4.2. get ready of whatwg streams spec.
-
def
state: WriteableState
The state getter returns the state of the stream see ¶4.2.4.3. get state of whatwg streams spec
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
write(chunk: Chunk[T]): Promise[Any]
The write method adds a write to the stream’s internal queue, instructing the stream to write the given chunk of data to the underlying sink once all other pending writes have finished successfully .
The write method adds a write to the stream’s internal queue, instructing the stream to write the given chunk of data to the underlying sink once all other pending writes have finished successfully . It returns a promise that will be fulfilled or rejected depending on the success or failure of writing the chunk to the underlying sink. The impact of enqueuing this chunk will be immediately reflected in the stream’s state property; in particular, if the internal queue is now full according to the stream’s queuing strategy, the stream will exert backpressure by changing its state to "waiting".
see 4.2.4.6. write(chunk) of whatwg streams spec
- returns
bblfish: not sure what the type of the promise returned is