akasha

Class WritableStream

java.lang.Object

akasha.core.JsObject

akasha.WritableStream

All Implemented Interfaces:

Transferable

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="WritableStream")
public class WritableStream
extends JsObject
implements Transferable

The WritableStream interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.

See Also:

WritableStream - MDN, (Streams) # ws-class

Constructor Summary

Constructors

Constructor and Description
WritableStream() The WritableStream() constructor creates a new WritableStream object instance.
WritableStream(JsObject underlyingSink) The WritableStream() constructor creates a new WritableStream object instance.
WritableStream(JsObject underlyingSink, QueuingStrategy strategy) The WritableStream() constructor creates a new WritableStream object instance.

Method Summary

Modifier and Type	Method and Description
@JsNonNull Promise<java.lang.Void>	abort() The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
@JsNonNull Promise<java.lang.Void>	abort(java.lang.Object reason) The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
@JsNonNull Promise<java.lang.Void>	close()
@JsNonNull WritableStreamDefaultWriter	getWriter() The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance.
boolean	locked() The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WritableStream

public WritableStream(@Nonnull
                      JsObject underlyingSink,
                      @Nonnull
                      QueuingStrategy strategy)

The WritableStream() constructor creates a new WritableStream object instance.

See Also:

WritableStream.WritableStream - MDN, WritableStream() - Streams

WritableStream

public WritableStream(@Nonnull
                      JsObject underlyingSink)

The WritableStream() constructor creates a new WritableStream object instance.

See Also:

WritableStream.WritableStream - MDN, WritableStream() - Streams

WritableStream

public WritableStream()

The WritableStream() constructor creates a new WritableStream object instance.

See Also:

WritableStream.WritableStream - MDN, WritableStream() - Streams

Method Detail

locked

@JsProperty(name="locked")
public boolean locked()

The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

See Also:

WritableStream.locked - MDN, locked - Streams

abort

public @JsNonNull Promise<java.lang.Void> abort(@Nullable
                                                java.lang.Object reason)

The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

See Also:

WritableStream.abort - MDN, abort() - Streams

abort

public @JsNonNull Promise<java.lang.Void> abort()

The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

See Also:

WritableStream.abort - MDN, abort() - Streams

close

public @JsNonNull Promise<java.lang.Void> close()

getWriter

public @JsNonNull WritableStreamDefaultWriter getWriter()

The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.

See Also:

WritableStream.getWriter - MDN, getWriter() - Streams