web

builtins
→
core
→
examples
→
mbtconv
→
node
→
wasm
→
web
→
README
U
AbortController
U
AbortSignal
U
AggregateError
U
Any
U
ArrayBuffer
U
AsyncDisposableStack
U
AsyncIterator
U
Atomics
U
AtomicsWaitResult
U
BigInt64Array
U
BigUint64Array
U
DataView
U
Date
U
DisposableStack
U
EvalError
U
FinalizationRegistry
U
Float32Array
U
Float64Array
U
Function
U
Int16Array
U
Int32Array
U
Int8Array
U
JSON
U
JsArray
U
JsBigInt
U
JsError
U
JsIterator
U
JsMap
U
JsSet
U
JsString
U
Math
U
Nullable
U
Nullish
U
Object
U
Promise
U
PromiseResolvers
U
Proxy
U
RangeError
U
ReferenceError
U
Reflect
U
RegExp
U
RegExpMatchArray
U
RegExpResult
U
SharedArrayBuffer
U
Symbol
U
SyntaxError
U
ThrowError
U
Timer
U
TypeError
U
TypedArray
U
URIError
U
Uint16Array
U
Uint32Array
U
Uint8Array
U
WeakMap
U
WeakRef
U
WeakSet
V
any
V
atob
V
btoa
V
clearInterval
V
clearTimeout
V
decodeURI
V
decodeURIComponent
V
dynamic_import
V
encodeURI
V
encodeURIComponent
V
from_async
V
from_entries
V
from_fn0
V
from_fn1
V
from_fn2
V
from_fn3
V
globalThis
V
identity
V
isFinite
V
isNaN
V
log
V
new
V
new_array
V
new_object
V
parseFloat
V
parseInt
V
promisify0
V
promisify1
V
promisify2
V
promisify3
V
queueMicrotask
V
run_async
V
setInterval
V
setTimeout
V
structuredClone
V
suspend
V
symbol
V
throwable
V
typeof_
V
undefined

README

streams

Streams API for processing data incrementally.

#Installation

Add to your moon.pkg.json:

{
  "import": [
    "mizchi/js",
    "mizchi/js/web/streams"
  ]
}

#Overview

Provides bindings for the Streams API: ReadableStream, WritableStream, and TransformStream.

#Usage Example

fn main {
  // Create a readable stream
  let readable = @streams.ReadableStream::new()

  // Get a reader
  let reader = readable.get_reader()

  // Create a writable stream
  let writable = @streams.WritableStream::new()

  // Get a writer
  let writer = writable.get_writer()

  // Create a transform stream
  let transform = @streams.TransformStream::new()

  // Pipe streams
  // readable.pipe_to(writable)
}

#Available Types

ReadableStream - Stream of data to read
WritableStream - Stream to write data to
TransformStream - Transform data in a stream
Compression/Decompression - gzip, deflate streams

#Reference

#
CompressionStream

source

pub(all) struct CompressionStream {
  readable : ReadableStream
  writable : WritableStream
}

CompressionStream is a TransformStream that compresses data using gzip, deflate, or deflate-raw https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream

#
CompressionStream::as_any

source

fn CompressionStream::as_any(self : CompressionStream) -> @mizchi/js/core.Any
Any

#
CompressionStream::new

source

fn CompressionStream::new(format : String) -> CompressionStream

Create a new CompressionStream with the specified format

Supported formats:

"gzip" - GZIP compression
"deflate" - DEFLATE compression (with zlib wrapper)
"deflate-raw" - DEFLATE compression (without wrapper)

Example:

let _compressor = CompressionStream::new("gzip")

#
DecompressionStream

source

pub(all) struct DecompressionStream {
  readable : ReadableStream
  writable : WritableStream
}

DecompressionStream is a TransformStream that decompresses data using gzip, deflate, or deflate-raw https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream

#
DecompressionStream::as_any

source

fn DecompressionStream::as_any(self : DecompressionStream) -> @mizchi/js/core.Any
Any

#
DecompressionStream::new

source

fn DecompressionStream::new(format : String) -> DecompressionStream

Create a new DecompressionStream with the specified format

Supported formats:

"gzip" - GZIP decompression
"deflate" - DEFLATE decompression (with zlib wrapper)
"deflate-raw" - DEFLATE decompression (without wrapper)

Example:

let _decompressor = DecompressionStream::new("gzip")

#
ReadableStream

source

#external
pub type ReadableStream

ReadableStream represents a readable stream of byte data https://developer.mozilla.org/ja/docs/Web/API/ReadableStream

#
ReadableStream::as_any

source

fn ReadableStream::as_any(self : ReadableStream) -> @mizchi/js/core.Any
Any

#
ReadableStream::cancel

source

async fn ReadableStream::cancel(self : ReadableStream, reason? : @mizchi/js/core.Any
Any) -> Unit

Cancel the stream

#
ReadableStream::getReader

source

#alias(get_reader)
fn ReadableStream::getReader(self : ReadableStream) -> ReadableStreamDefaultReader

Get a reader for this stream

#
ReadableStream::locked

source

fn ReadableStream::locked(self : ReadableStream) -> Bool

Check if the stream is locked

#
ReadableStream::new

source

fn ReadableStream::new(underlying_source : @mizchi/js/core.Any
Any) -> ReadableStream

Create a new ReadableStream with an underlying source

#
ReadableStream::pipeThrough

source

#alias(pipe_through)
fn ReadableStream::pipeThrough(self : ReadableStream, transform : @mizchi/js/core.Any
Any, options? : @mizchi/js/core.Any
Any) -> ReadableStream

Pipe through a transform stream

#
ReadableStream::pipeTo

source

#alias(pipe_to)
async fn ReadableStream::pipeTo(self : ReadableStream, destination : WritableStream, options? : @mizchi/js/core.Any
Any) -> Unit

Pipe this stream to a WritableStream

#
ReadableStream::tee

source

fn ReadableStream::tee(self : ReadableStream) -> (ReadableStream, ReadableStream)

Tee this stream into two branches

#
ReadableStreamDefaultReader

source

#external
pub type ReadableStreamDefaultReader

ReadableStreamDefaultReader represents a default reader for reading from a ReadableStream

#
ReadableStreamDefaultReader::as_any

source

fn ReadableStreamDefaultReader::as_any(self : ReadableStreamDefaultReader) -> @mizchi/js/core.Any
Any

#
ReadableStreamDefaultReader::cancel

source

async fn ReadableStreamDefaultReader::cancel(self : ReadableStreamDefaultReader, reason? : @mizchi/js/core.Any
Any) -> Unit

Cancel the stream

#
ReadableStreamDefaultReader::closed

source

fn ReadableStreamDefaultReader::closed(self : ReadableStreamDefaultReader) -> @mizchi/js/core.Promise
Promise[Unit]

Get the closed promise

#
ReadableStreamDefaultReader::read

source

async fn ReadableStreamDefaultReader::read(self : ReadableStreamDefaultReader) -> @mizchi/js/core.Any
Any

Read a chunk from the stream

#
ReadableStreamDefaultReader::releaseLock

source

#alias(release_lock)
fn ReadableStreamDefaultReader::releaseLock(self : ReadableStreamDefaultReader) -> Unit

Release the reader's lock on the stream

#
TransformStream

source

#external
pub type TransformStream

TransformStream represents a transform stream for piping data through a transformation

#
TransformStream::as_any

source

fn TransformStream::as_any(self : TransformStream) -> @mizchi/js/core.Any
Any

#
TransformStream::new

source

fn TransformStream::new(transformer : @mizchi/js/core.Any
Any) -> TransformStream

Create a new TransformStream with a transformer

#
TransformStream::new_identity

source

#alias(newIdentity)
fn TransformStream::new_identity() -> TransformStream

Create a new identity TransformStream (passes data through unmodified)

#
TransformStream::readable

source

fn TransformStream::readable(self : TransformStream) -> ReadableStream

Get the readable side of the transform stream

#
TransformStream::writable

source

fn TransformStream::writable(self : TransformStream) -> WritableStream

Get the writable side of the transform stream

#
WritableStream

source

#external
pub type WritableStream

WritableStream represents a writable stream

#
WritableStream::abort

source

async fn WritableStream::abort(self : WritableStream, reason? : @mizchi/js/core.Any
Any) -> Unit

Abort the stream

#
WritableStream::as_any

source

fn WritableStream::as_any(self : WritableStream) -> @mizchi/js/core.Any
Any

#
WritableStream::close

source

async fn WritableStream::close(self : WritableStream) -> Unit

Close the stream

#
WritableStream::getWriter

source

#alias(get_writer)
fn WritableStream::getWriter(self : WritableStream) -> WritableStreamDefaultWriter

Get a writer for this stream

#
WritableStream::locked

source

fn WritableStream::locked(self : WritableStream) -> Bool

Check if the stream is locked

#
WritableStream::new

source

fn WritableStream::new(underlying_sink : @mizchi/js/core.Any
Any) -> WritableStream

Create a new WritableStream with an underlying sink

#
WritableStreamDefaultWriter

source

#external
pub type WritableStreamDefaultWriter

WritableStreamDefaultWriter represents a default writer for writing to a WritableStream

#
WritableStreamDefaultWriter::abort

source

async fn WritableStreamDefaultWriter::abort(self : WritableStreamDefaultWriter, reason? : @mizchi/js/core.Any
Any) -> Unit

Abort the writer

#
WritableStreamDefaultWriter::as_any

source

fn WritableStreamDefaultWriter::as_any(self : WritableStreamDefaultWriter) -> @mizchi/js/core.Any
Any

#
WritableStreamDefaultWriter::close

source

async fn WritableStreamDefaultWriter::close(self : WritableStreamDefaultWriter) -> Unit

Close the writer

#
WritableStreamDefaultWriter::closed

source

fn WritableStreamDefaultWriter::closed(self : WritableStreamDefaultWriter) -> @mizchi/js/core.Promise
Promise[Unit]

Get the closed promise

#
WritableStreamDefaultWriter::desiredSize

source

fn WritableStreamDefaultWriter::desiredSize(self : WritableStreamDefaultWriter) -> @mizchi/js/core.Any
Any

Get the desired size

#
WritableStreamDefaultWriter::ready

source

fn WritableStreamDefaultWriter::ready(self : WritableStreamDefaultWriter) -> @mizchi/js/core.Promise
Promise[Unit]

Get the ready promise

#
WritableStreamDefaultWriter::releaseLock

source

#alias(release_lock)
fn WritableStreamDefaultWriter::releaseLock(self : WritableStreamDefaultWriter) -> Unit

Release the writer's lock on the stream

#
WritableStreamDefaultWriter::write

source

async fn WritableStreamDefaultWriter::write(self : WritableStreamDefaultWriter, chunk : @mizchi/js/core.Any
Any) -> Unit

Write a chunk to the stream

Source Files

Site source Report issue Packages Build queue Skills Statistics

#mizchi/js/web/streams

#Installation

#Overview

#Usage Example

#Available Types

#Reference

#CompressionStream

#CompressionStream::as_any

#CompressionStream::new

#DecompressionStream

#DecompressionStream::as_any

#DecompressionStream::new

#ReadableStream

#ReadableStream::as_any

#ReadableStream::cancel

#ReadableStream::getReader

#ReadableStream::locked

#ReadableStream::new

#ReadableStream::pipeThrough

#ReadableStream::pipeTo

#ReadableStream::tee

#ReadableStreamDefaultReader

#ReadableStreamDefaultReader::as_any

#ReadableStreamDefaultReader::cancel

#ReadableStreamDefaultReader::closed

#ReadableStreamDefaultReader::read

#ReadableStreamDefaultReader::releaseLock

#TransformStream

#TransformStream::as_any

#TransformStream::new

#TransformStream::new_identity

#TransformStream::readable

#TransformStream::writable

#WritableStream

#WritableStream::abort

#WritableStream::as_any

#WritableStream::close

#WritableStream::getWriter

#WritableStream::locked

#WritableStream::new

#WritableStreamDefaultWriter

#WritableStreamDefaultWriter::abort

#WritableStreamDefaultWriter::as_any

#WritableStreamDefaultWriter::close

#WritableStreamDefaultWriter::closed

#WritableStreamDefaultWriter::desiredSize

#WritableStreamDefaultWriter::ready

#WritableStreamDefaultWriter::releaseLock

#WritableStreamDefaultWriter::write

Source Files

#
CompressionStream

#
CompressionStream::as_any

#
CompressionStream::new

#
DecompressionStream

#
DecompressionStream::as_any

#
DecompressionStream::new

#
ReadableStream

#
ReadableStream::as_any

#
ReadableStream::cancel

#
ReadableStream::getReader

#
ReadableStream::locked

#
ReadableStream::new

#
ReadableStream::pipeThrough

#
ReadableStream::pipeTo

#
ReadableStream::tee

#
ReadableStreamDefaultReader

#
ReadableStreamDefaultReader::as_any

#
ReadableStreamDefaultReader::cancel

#
ReadableStreamDefaultReader::closed

#
ReadableStreamDefaultReader::read

#
ReadableStreamDefaultReader::releaseLock

#
TransformStream

#
TransformStream::as_any

#
TransformStream::new

#
TransformStream::new_identity

#
TransformStream::readable

#
TransformStream::writable

#
WritableStream

#
WritableStream::abort

#
WritableStream::as_any

#
WritableStream::close

#
WritableStream::getWriter

#
WritableStream::locked

#
WritableStream::new

#
WritableStreamDefaultWriter

#
WritableStreamDefaultWriter::abort

#
WritableStreamDefaultWriter::as_any

#
WritableStreamDefaultWriter::close

#
WritableStreamDefaultWriter::closed

#
WritableStreamDefaultWriter::desiredSize

#
WritableStreamDefaultWriter::ready

#
WritableStreamDefaultWriter::releaseLock

#
WritableStreamDefaultWriter::write