Skip to content

ReadableStream

Types

t

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

Record fields

locked
bool

Values

cancel

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

Parameters

t option< 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: (
FileTypes.underlyingSource<'t>,
~strategy: FileTypes.queuingStrategy<'t>=?,
) => t<'t>

Parameters

FileTypes.underlyingSource option< FileTypes.queuingStrategy >

Return type

t

getReader

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

Parameters

t option< FileTypes.readableStreamGetReaderOptions >

Return type

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

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

Parameters

t FileTypes.readableWritablePair option< FileTypes.streamPipeOptions >

Return type

t

pipeTo

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

Parameters

t FileTypes.writableStream option< FileTypes.streamPipeOptions >

Return type

promise< unit >

tee

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

Parameters

t

Return type

array< t< unit > >