ReadableStream

Overview

The ReadableStream interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

Location

 

cancel

Cancels the stream, signaling a loss of interest in the stream by a consumer. The supplied reason argument will be given to the underlying source, which may or may not use it.

 

method cancel(parreason: dynamic): dynamic

 

dynamic cancel(dynamic parreason)

 

func cancel(_ parreason: dynamic) -> dynamic

 

dynamic cancel(dynamic parreason)

 

Function cancel(parreason As dynamic) As dynamic

Parameters:

  • parreason:

getIterator

Creates a ReadableStream async iterator instance and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

 

method getIterator: ReadableStream

 

ReadableStream getIterator()

 

func getIterator() -> ReadableStream

 

ReadableStream getIterator()

 

Function getIterator() As ReadableStream

getReader

Creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

 

method getReader(parmode: dynamic): dynamic

 

dynamic getReader(dynamic parmode)

 

func getReader(_ parmode: dynamic) -> dynamic

 

dynamic getReader(dynamic parmode)

 

Function getReader(parmode As dynamic) As dynamic

Parameters:

  • parmode:

locked

 

property locked: dynamic read;

 

dynamic locked { get; }

 

var locked: dynamic { get{} }

 

dynamic locked { __get; }

 

ReadOnly Property locked() As dynamic

ReadableStream

Alias of getIterator method.

 

method ReadableStream: dynamic

 

dynamic ReadableStream()

 

func ReadableStream() -> dynamic

 

dynamic ReadableStream()

 

Function ReadableStream() As dynamic

tee

The tee method tees this readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances. Each of those streams receives the same incoming data.

 

method tee: dynamic

 

dynamic tee()

 

func tee() -> dynamic

 

dynamic tee()

 

Function tee() As dynamic

 

locked

 

property locked: dynamic read;

 

dynamic locked { get; }

 

var locked: dynamic { get{} }

 

dynamic locked { __get; }

 

ReadOnly Property locked() As dynamic

 

cancel

Cancels the stream, signaling a loss of interest in the stream by a consumer. The supplied reason argument will be given to the underlying source, which may or may not use it.

 

method cancel(parreason: dynamic): dynamic

 

dynamic cancel(dynamic parreason)

 

func cancel(_ parreason: dynamic) -> dynamic

 

dynamic cancel(dynamic parreason)

 

Function cancel(parreason As dynamic) As dynamic

Parameters:

  • parreason:

getIterator

Creates a ReadableStream async iterator instance and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

 

method getIterator: ReadableStream

 

ReadableStream getIterator()

 

func getIterator() -> ReadableStream

 

ReadableStream getIterator()

 

Function getIterator() As ReadableStream

getReader

Creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

 

method getReader(parmode: dynamic): dynamic

 

dynamic getReader(dynamic parmode)

 

func getReader(_ parmode: dynamic) -> dynamic

 

dynamic getReader(dynamic parmode)

 

Function getReader(parmode As dynamic) As dynamic

Parameters:

  • parmode:

ReadableStream

Alias of getIterator method.

 

method ReadableStream: dynamic

 

dynamic ReadableStream()

 

func ReadableStream() -> dynamic

 

dynamic ReadableStream()

 

Function ReadableStream() As dynamic

tee

The tee method tees this readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances. Each of those streams receives the same incoming data.

 

method tee: dynamic

 

dynamic tee()

 

func tee() -> dynamic

 

dynamic tee()

 

Function tee() As dynamic