ReadableStream

Types

t

Read more on MDN

type t<'r> = WebAPI.FileTypes.readableStream<'r>

Record fields

locked

bool

Read more on MDN

Values

cancel

Read more on MDN

let cancel: (t<'r>, ~reason: JSON.t=?) => promise<unit>

Parameters

toption<Stdlib.JSON.t>

Return type

promise<unit>

fromUnderlyingSource

fromUnderlyingSource(underlyingSource<'t>, ~strategy: queuingStrategy<'t>=?)

Creates a new ReadableStream from an underlyingSource, with an optional queuing strategy.

let stream = ReadableStream.fromUnderlyingSource(myUnderlyingSource)

let streamWithStrategy =
  ReadableStream.fromUnderlyingSource(myUnderlyingSource, ~strategy=myQueuingStrategy)

Read more on MDN

let fromUnderlyingSource: (
  WebAPI.FileTypes.underlyingSource<'t>,
  ~strategy: WebAPI.FileTypes.queuingStrategy<'t>=?,
) => t<'t>

Parameters

WebAPI.FileTypes.underlyingSourceoption<WebAPI.FileTypes.queuingStrategy>

Return type

t

getReader

Read more on MDN

let getReader: (
  t<'r>,
  ~options: WebAPI.FileTypes.readableStreamGetReaderOptions=?,
) => WebAPI.FileTypes.readableStreamReader<'r>

Parameters

toption<WebAPI.FileTypes.readableStreamGetReaderOptions>

Return type

WebAPI.FileTypes.readableStreamReader

make

make()

Creates a new empty ReadableStream.

let stream: ReadableStream.t<string> = ReadableStream.make()

Read more on MDN

let make: unit => t<'t>

Parameters

unit

Return type

t

pipeThrough

Read more on MDN

let pipeThrough: (
  t<'r>,
  ~transform: WebAPI.FileTypes.readableWritablePair<'t, 'r>,
  ~options: WebAPI.FileTypes.streamPipeOptions=?,
) => t<'t>

Parameters

tWebAPI.FileTypes.readableWritablePairoption<WebAPI.FileTypes.streamPipeOptions>

Return type

t

pipeTo

Read more on MDN

let pipeTo: (
  t<'r>,
  ~destination: WebAPI.FileTypes.writableStream<'r>,
  ~options: WebAPI.FileTypes.streamPipeOptions=?,
) => promise<unit>

Parameters

tWebAPI.FileTypes.writableStreamoption<WebAPI.FileTypes.streamPipeOptions>

Return type

promise<unit>

tee

Read more on MDN

let tee: t<'r> => array<t<unit>>

Parameters

t

Return type

array<t<unit>>