{ } qjs-modules

stream

Source: lib/stream.js — WHATWG Streams implementation, compiled into qjsm as the stream module.

Module exports: ReadableStream, ReadableStreamDefaultReader, ReadableStreamBYOBReader, ReadableStreamDefaultController, ReadableByteStreamController, WritableStream, WritableStreamDefaultWriter, WritableStreamDefaultController, TransformStream.

ReadableStream

new ReadableStream(underlyingSource[, strategy])   // length 1
MemberArgsKindDescription
cancel(reason)0methodCancels the stream.
getReader([options])0methodAcquires a reader (default or BYOB).
closed—getterPromise settling on close (enumerable).
locked—getterWhether a reader holds the stream (enumerable).

Readers (ReadableStreamDefaultReader, ReadableStreamBYOBReader)

new ReadableStreamDefaultReader(stream)   // length 1
MemberArgsKindDescription
read([view])0methodReads the next chunk; resolves {value, done}.
cancel(reason)0methodCancels and releases.
releaseLock()0methodReleases the reader's lock.
closed—getterClosed promise.

Controllers

ReadableStreamDefaultController / ReadableByteStreamController (passed to the source): close(), enqueue(chunk), error(e), and getter desiredSize. ReadableStreamBYOBRequest: respond(n), respondWithNewView(view).

WritableStream

new WritableStream(underlyingSink[, strategy])   // length 1
MemberArgsKindDescription
abort(reason)1methodAborts the stream.
close()0methodCloses the stream.
getWriter()0methodAcquires a writer.
locked—getterWhether a writer holds the stream (enumerable).

WritableStreamDefaultWriter

new WritableStreamDefaultWriter(stream)   // length 1

write(chunk), abort(reason), close(), releaseLock(); getters closed, ready.

WritableStreamDefaultController

error(e) (and the controller passed to the sink).

TransformStream

new TransformStream(transformer[, writableStrategy, readableStrategy])   // length 1

Getters readable and writable (both enumerable) expose the paired streams. Its controller offers terminate(), enqueue(chunk), error(e) and a desiredSize getter.

Export list

Generated by utilities/doc-api.js from the stream dump of utilities/api-surface.sh: 106 members. Edit the text above this block, not the block.

ByteLengthQueuingStrategy

class, constructible

  • properties: highWaterMark (get), size (get), [Symbol.toStringTag]

CountQueuingStrategy

class, constructible

  • properties: highWaterMark (get), size (get), [Symbol.toStringTag]

ReadableByteStreamController

class, constructible

  • methods: close(), enqueue(), error(), [Symbol([[CancelSteps]])](), [Symbol([[PullSteps]])](), [Symbol([[ReleaseSteps]])]()
  • properties: byobRequest (get), desiredSize (get), [Symbol.toStringTag]

ReadableStream

class, constructible

  • static methods: from()
  • methods: cancel(), getReader(), pipeThrough(), pipeTo(), tee(), values(), [Symbol.asyncIterator]()
  • properties: locked (get), [Symbol.toStringTag]

ReadableStreamAsyncIteratorImpl

class, constructible

  • methods: _nextSteps(), _returnSteps(), next(), return()

ReadableStreamBYOBReader

class, constructible

  • methods: cancel(), read(), releaseLock()
  • properties: closed (get), [Symbol.toStringTag]

ReadableStreamBYOBRequest

class, constructible

  • methods: respond(), respondWithNewView()
  • properties: view (get), [Symbol.toStringTag]

ReadableStreamDefaultController

class, constructible

  • methods: close(), enqueue(), error(), [Symbol([[CancelSteps]])](), [Symbol([[PullSteps]])](), [Symbol([[ReleaseSteps]])]()
  • properties: desiredSize (get), [Symbol.toStringTag]

ReadableStreamDefaultReader

class, constructible

  • methods: cancel(), read(), releaseLock()
  • properties: closed (get), [Symbol.toStringTag]

TransformStream

class, constructible

  • properties: readable (get), writable (get), [Symbol.toStringTag]

TransformStreamDefaultController

class, constructible

  • methods: enqueue(), error(), terminate()
  • properties: desiredSize (get), [Symbol.toStringTag]

WritableStream

class, constructible

  • methods: abort(), close(), getWriter()
  • properties: locked (get), [Symbol.toStringTag]

WritableStreamDefaultController

class, constructible

  • methods: error(), [Symbol([[AbortSteps]])](), [Symbol([[ErrorSteps]])]()
  • properties: abortReason (get), signal (get), [Symbol.toStringTag]

WritableStreamDefaultWriter

class, constructible

  • methods: abort(), close(), releaseLock(), write()
  • properties: closed (get), desiredSize (get), ready (get), [Symbol.toStringTag]