gossamer - v4.0.0

gossamer/readable_stream

Types

ReadableStream

</> 
pub type ReadableStream(a)

Values

async_iterator

</> 
pub fn async_iterator(
  stream: ReadableStream(a),
) -> async_iterator.AsyncIterator(a, Nil, Nil)

cancel

</> 
pub fn cancel(
  stream: ReadableStream(a),
  reason: r,
) -> promise.Promise(Nil)

from

</> 
pub fn from(iterable: a) -> ReadableStream(b)

Creates a ReadableStream from an iterable or async iterable.

Note: Not available on Bun. See https://github.com/oven-sh/bun/issues/3700

from_pull

</> 
pub fn from_pull(
  pull: fn(default_controller.DefaultController(a)) -> promise.Promise(
    Nil,
  ),
) -> ReadableStream(a)

from_start

</> 
pub fn from_start(
  start: fn(default_controller.DefaultController(a)) -> Nil,
) -> ReadableStream(a)

get_byob_reader

</> 
pub fn get_byob_reader(
  stream: ReadableStream(a),
) -> byob_reader.ByobReader(a)

get_reader

</> 
pub fn get_reader(stream: ReadableStream(a)) -> reader.Reader(a)

is_locked

</> 
pub fn is_locked(stream: ReadableStream(a)) -> Bool

new

</> 
pub fn new(
  source: List(underlying_source.UnderlyingSource(a)),
) -> ReadableStream(a)

pipe_through

</> 
pub fn pipe_through(
  stream: ReadableStream(a),
  transform: #(
    ReadableStream(b),
    writable_stream.WritableStream(a),
  ),
  options: List(stream_pipe_option.StreamPipeOption),
) -> ReadableStream(b)

pipe_to

</> 
pub fn pipe_to(
  stream: ReadableStream(a),
  destination: writable_stream.WritableStream(a),
  options: List(stream_pipe_option.StreamPipeOption),
) -> promise.Promise(Nil)

tee

</> 
pub fn tee(
  stream: ReadableStream(a),
) -> #(ReadableStream(a), ReadableStream(a))
✨ Search Document