Interface Controllable<T>

A common interface for controllable streams.

interface Controllable<T> {
    desiredSize: null | number;
    close(): void;
    enqueue(chunk?): void;
    error(e?): void;
    onPull(pullListener): (() => void);
}

Type Parameters

T

Hierarchy (view full)

ReadableStreamDefaultController<T>
- Controllable
  - ControllableReadableStream

Implemented by

Index

Properties

Methods

close enqueue error onPull

Properties

`Readonly` desiredSize

desiredSize: null | number

Methods

close

close(): void
Returns void
Inherited from ReadableStreamDefaultController.close
- Defined in .yarn/cache/typescript-patch-ce5481e54d-b1b62606c7.zip/node_modules/typescript/lib/lib.dom.d.ts:11831

enqueue

enqueue(chunk?): void
Parameters
- Optional chunk: T
Returns void
Inherited from ReadableStreamDefaultController.enqueue
- Defined in .yarn/cache/typescript-patch-ce5481e54d-b1b62606c7.zip/node_modules/typescript/lib/lib.dom.d.ts:11832

error

error(e?): void
Parameters
- Optional e: any
Returns void
Inherited from ReadableStreamDefaultController.error
- Defined in .yarn/cache/typescript-patch-ce5481e54d-b1b62606c7.zip/node_modules/typescript/lib/lib.dom.d.ts:11833

onPull

onPull(pullListener): (() => void)
Register a pull subscriber.

When the stream is ready to pull it will pull from all subscribers until the desired size has been fulfilled.
Parameters
- pullListener: ControllerPullListener<T>
Returns (() => void)
- - (): void
  - Returns void
- Defined in packages/stream/src/sources/Controllable.ts:13

Generated using TypeDoc