@caido/quickjs-types / llrt/stream/web

llrt/stream/web

Modules

Module	Description
stream/web	-

Interfaces

ByteLengthQueuingStrategy

Extends

• _ByteLengthQueuingStrategy

Properties

highWaterMark

readonly highWaterMark: number

Inherited from

_ByteLengthQueuingStrategy.highWaterMark

size

readonly size: QueuingStrategySize<ArrayBufferView>

Inherited from

_ByteLengthQueuingStrategy.size

---

CountQueuingStrategy

Extends

• _CountQueuingStrategy

Properties

highWaterMark

readonly highWaterMark: number

Inherited from

_CountQueuingStrategy.highWaterMark

size

readonly size: QueuingStrategySize

Inherited from

_CountQueuingStrategy.size

---

ReadableByteStreamController

Extends

• _ReadableByteStreamController

Properties

byobRequest

readonly byobRequest: undefined

Inherited from

_ReadableByteStreamController.byobRequest

desiredSize

readonly desiredSize: number | null

Inherited from

_ReadableByteStreamController.desiredSize

Methods

close()

close(): void

Returns

void

Inherited from

_ReadableByteStreamController.close

enqueue()

enqueue(chunk: ArrayBufferView): void

Parameters

Parameter	Type
chunk	ArrayBufferView

Returns

void

Inherited from

_ReadableByteStreamController.enqueue

error()

error(error?: any): void

Parameters

Parameter	Type
error?	any

Returns

void

Inherited from

_ReadableByteStreamController.error

---

ReadableStream

Extends

• _ReadableStream<R>

Type Parameters

Type Parameter	Default type
R	any

Properties

locked

readonly locked: boolean

Inherited from

_ReadableStream.locked

Methods

[asyncIterator]()

[asyncIterator](): ReadableStreamAsyncIterator<R>

Returns

ReadableStreamAsyncIterator<R>

Inherited from

_ReadableStream.[asyncIterator]

cancel()

cancel(reason?: any): Promise<void>

Parameters

Parameter	Type
reason?	any

Returns

Promise<void>

Inherited from

_ReadableStream.cancel

getReader()

Call Signature

getReader(options: object): ReadableStreamBYOBReader

Parameters

Parameter	Type
options	{ mode: "byob"; }
options.mode	"byob"

Returns

ReadableStreamBYOBReader

Inherited from

_ReadableStream.getReader

Call Signature

getReader(): ReadableStreamDefaultReader<R>

Returns

ReadableStreamDefaultReader<R>

Inherited from

_ReadableStream.getReader

Call Signature

getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>

Parameters

Parameter	Type
options?	ReadableStreamGetReaderOptions

Returns

ReadableStreamReader<R>

Inherited from

_ReadableStream.getReader

pipeThrough()

pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
transform	ReadableWritablePair<T, R>
options?	StreamPipeOptions

Returns

ReadableStream<T>

Inherited from

_ReadableStream.pipeThrough

pipeTo()

pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>

Parameters

Parameter	Type
destination	WritableStream<R>
options?	StreamPipeOptions

Returns

Promise<void>

Inherited from

_ReadableStream.pipeTo

tee()

tee(): [ReadableStream<R>, ReadableStream<R>]

Returns

[ReadableStream<R>, ReadableStream<R>]

Inherited from

_ReadableStream.tee

values()

values(options?: object): ReadableStreamAsyncIterator<R>

Parameters

Parameter	Type
options?	{ preventCancel?: boolean; }
options.preventCancel?	boolean

Returns

ReadableStreamAsyncIterator<R>

Inherited from

_ReadableStream.values

---

ReadableStreamBYOBReader

Extends

• _ReadableStreamBYOBReader

Properties

closed

readonly closed: Promise<undefined>

Inherited from

_ReadableStreamBYOBReader.closed

Methods

cancel()

cancel(reason?: any): Promise<void>

Parameters

Parameter	Type
reason?	any

Returns

Promise<void>

Inherited from

_ReadableStreamBYOBReader.cancel

read()

read<T>(view: T): Promise<ReadableStreamReadResult<T>>

MDN Reference

Type Parameters

Type Parameter
T extends ArrayBufferView

Parameters

Parameter	Type
view	T

Returns

Promise<ReadableStreamReadResult<T>>

Inherited from

_ReadableStreamBYOBReader.read

releaseLock()

releaseLock(): void

MDN Reference

Returns

void

Inherited from

_ReadableStreamBYOBReader.releaseLock

---

ReadableStreamBYOBRequest

Extends

• _ReadableStreamBYOBRequest

Properties

view

readonly view: ArrayBufferView | null

MDN Reference

Inherited from

_ReadableStreamBYOBRequest.view

Methods

respond()

respond(bytesWritten: number): void

MDN Reference

Parameters

Parameter	Type
bytesWritten	number

Returns

void

Inherited from

_ReadableStreamBYOBRequest.respond

respondWithNewView()

respondWithNewView(view: ArrayBufferView): void

MDN Reference

Parameters

Parameter	Type
view	ArrayBufferView

Returns

void

Inherited from

_ReadableStreamBYOBRequest.respondWithNewView

---

ReadableStreamDefaultController

Extends

• _ReadableStreamDefaultController<R>

Type Parameters

Type Parameter	Default type
R	any

Properties

desiredSize

readonly desiredSize: number | null

Inherited from

_ReadableStreamDefaultController.desiredSize

Methods

close()

close(): void

Returns

void

Inherited from

_ReadableStreamDefaultController.close

enqueue()

enqueue(chunk?: R): void

Parameters

Parameter	Type
chunk?	R

Returns

void

Inherited from

_ReadableStreamDefaultController.enqueue

error()

error(e?: any): void

Parameters

Parameter	Type
e?	any

Returns

void

Inherited from

_ReadableStreamDefaultController.error

---

ReadableStreamDefaultReader

Extends

• _ReadableStreamDefaultReader<R>

Type Parameters

Type Parameter	Default type
R	any

Properties

closed

readonly closed: Promise<undefined>

Inherited from

_ReadableStreamDefaultReader.closed

Methods

cancel()

cancel(reason?: any): Promise<void>

Parameters

Parameter	Type
reason?	any

Returns

Promise<void>

Inherited from

_ReadableStreamDefaultReader.cancel

read()

read(): Promise<ReadableStreamReadResult<R>>

Returns

Promise<ReadableStreamReadResult<R>>

Inherited from

_ReadableStreamDefaultReader.read

releaseLock()

releaseLock(): void

Returns

void

Inherited from

_ReadableStreamDefaultReader.releaseLock

---

WritableStream

Extends

• _WritableStream<W>

Type Parameters

Type Parameter	Default type
W	any

Properties

locked

readonly locked: boolean

Inherited from

_WritableStream.locked

Methods

abort()

abort(reason?: any): Promise<void>

Parameters

Parameter	Type
reason?	any

Returns

Promise<void>

Inherited from

_WritableStream.abort

close()

close(): Promise<void>

Returns

Promise<void>

Inherited from

_WritableStream.close

getWriter()

getWriter(): WritableStreamDefaultWriter<W>

Returns

WritableStreamDefaultWriter<W>

Inherited from

_WritableStream.getWriter

---

WritableStreamDefaultController

Extends

• _WritableStreamDefaultController

Methods

error()

error(e?: any): void

Parameters

Parameter	Type
e?	any

Returns

void

Inherited from

_WritableStreamDefaultController.error

---

WritableStreamDefaultWriter

Extends

• _WritableStreamDefaultWriter<W>

Type Parameters

Type Parameter	Default type
W	any

Properties

closed

readonly closed: Promise<undefined>

Inherited from

_WritableStreamDefaultWriter.closed

desiredSize

readonly desiredSize: number | null

Inherited from

_WritableStreamDefaultWriter.desiredSize

ready

readonly ready: Promise<undefined>

Inherited from

_WritableStreamDefaultWriter.ready

Methods

abort()

abort(reason?: any): Promise<void>

Parameters

Parameter	Type
reason?	any

Returns

Promise<void>

Inherited from

_WritableStreamDefaultWriter.abort

close()

close(): Promise<void>

Returns

Promise<void>

Inherited from

_WritableStreamDefaultWriter.close

releaseLock()

releaseLock(): void

Returns

void

Inherited from

_WritableStreamDefaultWriter.releaseLock

write()

write(chunk?: W): Promise<void>

Parameters

Parameter	Type
chunk?	W

Returns

Promise<void>

Inherited from

_WritableStreamDefaultWriter.write

Type Aliases

_ByteLengthQueuingStrategy

_ByteLengthQueuingStrategy = typeof globalThis extends object ? object : ByteLengthQueuingStrategy

---

_CountQueuingStrategy

_CountQueuingStrategy = typeof globalThis extends object ? object : CountQueuingStrategy

---

_ReadableByteStreamController

_ReadableByteStreamController = typeof globalThis extends object ? object : ReadableByteStreamController

---

_ReadableStream

_ReadableStream<R> = typeof globalThis extends object ? object : ReadableStream

Type Parameters

Type Parameter	Default type
R	any

---

_ReadableStreamBYOBReader

_ReadableStreamBYOBReader = typeof globalThis extends object ? object : ReadableStreamBYOBReader

---

_ReadableStreamBYOBRequest

_ReadableStreamBYOBRequest = typeof globalThis extends object ? object : ReadableStreamBYOBRequest

---

_ReadableStreamDefaultController

_ReadableStreamDefaultController<R> = typeof globalThis extends object ? object : ReadableStreamDefaultController

Type Parameters

Type Parameter	Default type
R	any

---

_ReadableStreamDefaultReader

_ReadableStreamDefaultReader<R> = typeof globalThis extends object ? object : ReadableStreamDefaultReader

Type Parameters

Type Parameter	Default type
R	any

---

_WritableStream

_WritableStream<W> = typeof globalThis extends object ? object : WritableStream

Type Parameters

Type Parameter	Default type
W	any

---

_WritableStreamDefaultController

_WritableStreamDefaultController = typeof globalThis extends object ? object : WritableStreamDefaultController

---

_WritableStreamDefaultWriter

_WritableStreamDefaultWriter<W> = typeof globalThis extends object ? object : WritableStreamDefaultWriter

Type Parameters

Type Parameter	Default type
W	any

Variables

ByteLengthQueuingStrategy

ByteLengthQueuingStrategy: {(init: QueuingStrategyInit): ByteLengthQueuingStrategy; prototype: ByteLengthQueuingStrategy; }

ByteLengthQueuingStrategy class is a global reference for import { ByteLengthQueuingStrategy } from 'stream/web'. https://nodejs.org/api/globals.html#class-bytelengthqueuingstrategy

Type Declaration

Parameters

Parameter	Type
init	QueuingStrategyInit

Returns

ByteLengthQueuingStrategy

prototype

prototype: ByteLengthQueuingStrategy

Since

v18.0.0

---

CountQueuingStrategy

CountQueuingStrategy: {(init: QueuingStrategyInit): CountQueuingStrategy; prototype: CountQueuingStrategy; }

CountQueuingStrategy class is a global reference for import { CountQueuingStrategy } from 'stream/web'. https://nodejs.org/api/globals.html#class-countqueuingstrategy

Type Declaration

Parameters

Parameter	Type
init	QueuingStrategyInit

Returns

CountQueuingStrategy

prototype

prototype: CountQueuingStrategy

Since

v18.0.0

---

ReadableByteStreamController

ReadableByteStreamController: {(): ReadableByteStreamController; prototype: ReadableByteStreamController; }

ReadableByteStreamController class is a global reference for import { ReadableByteStreamController } from 'stream/web'. https://nodejs.org/api/globals.html#class-readablebytestreamcontroller

Type Declaration

Returns

ReadableByteStreamController

prototype

prototype: ReadableByteStreamController

Since

v18.0.0

---

ReadableStream

ReadableStream: {(underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy<Uint8Array>): ReadableStream<Uint8Array>; <R>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>; prototype: ReadableStream; from: ReadableStream<T>; }

ReadableStream class is a global reference for import { ReadableStream } from 'stream/web'. https://nodejs.org/api/globals.html#class-readablestream

Type Declaration

Call Signature

new ReadableStream(underlyingSource: UnderlyingByteSource, strategy?: QueuingStrategy<Uint8Array>): ReadableStream<Uint8Array>

Parameters

Parameter	Type
underlyingSource	UnderlyingByteSource
strategy?	QueuingStrategy<Uint8Array>

Returns

ReadableStream<Uint8Array>

Call Signature

new ReadableStream<R>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>

Parameters

Parameter	Type
underlyingSource?	UnderlyingSource<R>
strategy?	QueuingStrategy<R>

Returns

ReadableStream<R>

prototype

prototype: ReadableStream

from()

from<T>(iterable: Iterable<T, any, any> | AsyncIterable<T, any, any>): ReadableStream<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
iterable	Iterable<T, any, any> | AsyncIterable<T, any, any>

Returns

ReadableStream<T>

Since

v18.0.0

---

ReadableStreamBYOBReader

ReadableStreamBYOBReader: {(stream: ReadableStream): ReadableStreamBYOBReader; prototype: ReadableStreamBYOBReader; }

ReadableStreamBYOBReader class is a global reference for import { ReadableStreamBYOBReader } from 'stream/web'. https://nodejs.org/api/globals.html#class-readablestreambyobreader

Type Declaration

Parameters

Parameter	Type
stream	ReadableStream

Returns

ReadableStreamBYOBReader

prototype

prototype: ReadableStreamBYOBReader

Since

v18.0.0

---

ReadableStreamBYOBRequest

ReadableStreamBYOBRequest: {(): ReadableStreamBYOBRequest; prototype: ReadableStreamBYOBRequest; }

ReadableStreamBYOBRequest class is a global reference for import { ReadableStreamBYOBRequest } from 'stream/web'. https://nodejs.org/api/globals.html#class-readablestreambyobrequest

Type Declaration

Returns

ReadableStreamBYOBRequest

prototype

prototype: ReadableStreamBYOBRequest

Since

v18.0.0

---

ReadableStreamDefaultController

ReadableStreamDefaultController: {(): ReadableStreamDefaultController; prototype: ReadableStreamDefaultController; }

ReadableStreamDefaultController class is a global reference for import { ReadableStreamDefaultController } from 'stream/web'. https://nodejs.org/api/globals.html#class-readablestreamdefaultcontroller

Type Declaration

Returns

ReadableStreamDefaultController

prototype

prototype: ReadableStreamDefaultController

Since

v18.0.0

---

ReadableStreamDefaultReader

ReadableStreamDefaultReader: {<R>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>; prototype: ReadableStreamDefaultReader; }

ReadableStreamDefaultReader class is a global reference for import { ReadableStreamDefaultReader } from 'stream/web'. https://nodejs.org/api/globals.html#class-readablestreamdefaultreader

Type Declaration

Parameters

Parameter	Type
stream	ReadableStream<R>

Returns

ReadableStreamDefaultReader<R>

prototype

prototype: ReadableStreamDefaultReader

Since

v18.0.0

---

WritableStream

WritableStream: {<W>(underlyingSink?: UnderlyingSink<W>, strategy?: QueuingStrategy<W>): WritableStream<W>; prototype: WritableStream; }

WritableStream class is a global reference for import { WritableStream } from 'stream/web'. https://nodejs.org/api/globals.html#class-writablestream

Type Declaration

Parameters

Parameter	Type
underlyingSink?	UnderlyingSink<W>
strategy?	QueuingStrategy<W>

Returns

WritableStream<W>

prototype

prototype: WritableStream

Since

v18.0.0

---

WritableStreamDefaultController

WritableStreamDefaultController: {(): WritableStreamDefaultController; prototype: WritableStreamDefaultController; }

WritableStreamDefaultController class is a global reference for import { WritableStreamDefaultController } from 'stream/web'. https://nodejs.org/api/globals.html#class-writablestreamdefaultcontroller

Type Declaration

Returns

WritableStreamDefaultController

prototype

prototype: WritableStreamDefaultController

Since

v18.0.0

---

WritableStreamDefaultWriter

WritableStreamDefaultWriter: {<W>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>; prototype: WritableStreamDefaultWriter; }

WritableStreamDefaultWriter class is a global reference for import { WritableStreamDefaultWriter } from 'stream/web'. https://nodejs.org/api/globals.html#class-writablestreamdefaultwriter

Type Declaration

Parameters

Parameter	Type
stream	WritableStream<W>

Returns

WritableStreamDefaultWriter<W>

prototype

prototype: WritableStreamDefaultWriter

Since

v18.0.0