Class WhatwgStreamIAdapter

Hierarchy (View Summary)

BaseStream<true>
- WhatwgStreamIAdapter

Index

Constructors

Properties

events isAsync reader source

Accessors

closed pullable

Methods

close destroyDumpQueue pull

Constructors

constructor

new WhatwgStreamIAdapter(source: ReadableStream): WhatwgStreamIAdapter
Parameters
- source: ReadableStream
Returns WhatwgStreamIAdapter
Overrides BaseStream.constructor
- Defined in src/simplestreams/adapters.ts:58

Properties

`Readonly`events

events: SimpleEventEmitter<baseStreamEvents>

`Readonly`isAsync

isAsync: true

reader

reader: ReadableStreamDefaultReader

`Readonly`source

source: ReadableStream

Accessors

closed

get closed(): boolean
Returns boolean
Inherited from BaseStream.closed
- Defined in src/simplestreams/base.ts:11

pullable

get pullable(): boolean
Returns boolean
Inherited from BaseStream.pullable
- Defined in src/simplestreams/base.ts:30

Methods

close

close(): void
Returns void
Inherited from BaseStream.close
- Defined in src/simplestreams/base.ts:15

destroyDumpQueue

destroyDumpQueue(): Promise<Uint8Array<ArrayBufferLike>[]>
Close the stream, and return all of the queued data

Returns Promise<Uint8Array<ArrayBufferLike>[]>
Inherited from BaseStream.destroyDumpQueue
- Defined in src/simplestreams/base.ts:79

pull

pull(ideal: number): Promise<Uint8Array<ArrayBufferLike>>
Grab some data from the stream.
Parameters
- ideal: number
  The ideal amount of data. Implementers should ignore this if there data is chunked, and instead give the whole chunk. If they do not yet have a full chunk, give what you have.
Returns Promise<Uint8Array<ArrayBufferLike>>
Uint8Array containing the data, but if there will be more data, there just is not yet, AND the stream is sync, it will give undefined.
Inherited from BaseStream.pull
- Defined in src/simplestreams/base.ts:63