Liking cljdoc? Tell your friends :D

web.fetch.ReadableByteStreamController

The ReadableByteStreamController interface of the Streams API a controller allowing control of a web.files.ReadableStream's and internal queue. Byte stream controllers are for byte streams.

The ReadableByteStreamController interface of the Streams API
a controller allowing control of a `web.files.ReadableStream`'s
and internal queue. Byte stream controllers are for byte streams.
raw docstring

byob-requestcljs

(byob-request this)

Property.

[Draft] [Experimental]

The byobRequest getter property of the web.fetch.ReadableByteStreamController returns the current BYOB pull request.

var request = readableByteStreamControllerInstance.byobRequest;

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/byobRequest

Property.

[Draft]
[Experimental]

The byobRequest getter property of the `web.fetch.ReadableByteStreamController`
returns the current BYOB pull request.

`var request = readableByteStreamControllerInstance.byobRequest;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/byobRequest`
sourceraw docstring

closecljs

(close this)

Method.

[Draft] [Experimental]

The close() method of the web.fetch.ReadableByteStreamController closes the associated stream.

readableByteStreamControllerInstance.close();

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/close

Method.

[Draft]
[Experimental]

The close() method of the `web.fetch.ReadableByteStreamController`
closes the associated stream.

`readableByteStreamControllerInstance.close();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/close`
sourceraw docstring

constructorcljs

(constructor & args)

Constructor.

The ReadableByteStreamController() constructor creates and returns a ReadableByteStreamController() object instance.

stream The web.files.ReadableStream to be controlled. underlyingSource An object containing methods and properties that define how the constructed stream instance will behave. See the ReadableStream() constructor's parameters definitions for more information. highWaterMark A non-negative integer — this defines the total number of chunks that can be contained in the internal queue before backpressure is applied.

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/ReadableByteStreamController

Constructor.

The ReadableByteStreamController() constructor creates and returns a ReadableByteStreamController() object instance.

stream
The `web.files.ReadableStream` to be controlled.
underlyingSource
An object containing methods and properties that define how the constructed stream instance will behave. See the ReadableStream() constructor's parameters definitions for more information.
highWaterMark
A non-negative integer — this defines the total number of chunks that can be contained in the internal queue before backpressure is applied.

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/ReadableByteStreamController`
sourceraw docstring

desired-sizecljs

(desired-size this)

Property.

[Draft] [Experimental]

The desiredSize getter property of the web.fetch.ReadableByteStreamController returns the desired size required to fill the stream's internal

var desiredSize = readableByteStreamControllerInstance.desiredSize;

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/desiredSize

Property.

[Draft]
[Experimental]

The desiredSize getter property of the `web.fetch.ReadableByteStreamController`
returns the desired size required to fill the stream's internal

`var desiredSize = readableByteStreamControllerInstance.desiredSize;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/desiredSize`
sourceraw docstring

enqueuecljs

(enqueue this chunk)

Method.

[Draft] [Experimental]

The enqueue() method of the web.fetch.ReadableByteStreamController enqueues a given chunk in the associated stream.

readableByteStreamControllerInstance.enqueue(chunk);

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/enqueue

Method.

[Draft]
[Experimental]

The enqueue() method of the `web.fetch.ReadableByteStreamController`
enqueues a given chunk in the associated stream.

`readableByteStreamControllerInstance.enqueue(chunk);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/enqueue`
sourceraw docstring

errorcljs

(error this e)

Method.

[Draft] [Experimental]

The error() method of the web.fetch.ReadableByteStreamController causes any future interactions with the associated stream to

readableByteStreamControllerInstance.error(e);

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/error

Method.

[Draft]
[Experimental]

The error() method of the `web.fetch.ReadableByteStreamController`
causes any future interactions with the associated stream to

`readableByteStreamControllerInstance.error(e);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/error`
sourceraw docstring

set-byob-request!cljs

(set-byob-request! this val)

Property.

[Draft] [Experimental]

The byobRequest getter property of the web.fetch.ReadableByteStreamController returns the current BYOB pull request.

var request = readableByteStreamControllerInstance.byobRequest;

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/byobRequest

Property.

[Draft]
[Experimental]

The byobRequest getter property of the `web.fetch.ReadableByteStreamController`
returns the current BYOB pull request.

`var request = readableByteStreamControllerInstance.byobRequest;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/byobRequest`
sourceraw docstring

set-desired-size!cljs

(set-desired-size! this val)

Property.

[Draft] [Experimental]

The desiredSize getter property of the web.fetch.ReadableByteStreamController returns the desired size required to fill the stream's internal

var desiredSize = readableByteStreamControllerInstance.desiredSize;

See also: https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/desiredSize

Property.

[Draft]
[Experimental]

The desiredSize getter property of the `web.fetch.ReadableByteStreamController`
returns the desired size required to fill the stream's internal

`var desiredSize = readableByteStreamControllerInstance.desiredSize;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController/desiredSize`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close