Class DynamicSource<IsAsync>

Type Parameters

IsAsync extends boolean

Hierarchy (View Summary)

BaseStream<IsAsync>
- DynamicSource

Implements

Sourced<BaseStream<IsAsync> | undefined>

Index

Constructors

Properties

Accessors

closed pullable source

Methods

close destroyDumpQueue pull setSource

Constructors

constructor

new DynamicSource<IsAsync extends boolean>(
isAsync: IsAsync,
): DynamicSource<IsAsync>
Create a dynamic source. This relays all pulls to the current source, which may be changed. If this stream is closed, the current source will be too.
Type Parameters
- IsAsync extends boolean
Parameters
- isAsync: IsAsync
  If the class is async
Returns DynamicSource<IsAsync>
Overrides BaseStream.constructor
- Defined in src/simplestreams/dynamicSource.ts:36

Properties

`Readonly`events

events: SimpleEventEmitter<DynamicSourceEvents>

`Readonly`isAsync

isAsync: IsAsync

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

source

get source(): BaseStream<IsAsync> | undefined
The source of this class. IMPLEMENTERS: make it readonly

Returns BaseStream<IsAsync> | undefined
Implementation of Sourced.source
- Defined in src/simplestreams/dynamicSource.ts:27

Methods

close

close(): void
Returns void
Overrides BaseStream.close
- Defined in src/simplestreams/dynamicSource.ts:90

destroyDumpQueue

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

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

pull

pull(ideal: number): MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>
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 MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>
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

setSource

setSource(
newSource: BaseStream<IsAsync> | undefined,
): MaybePromise<void, IsAsync>
Parameters
- newSource: BaseStream<IsAsync> | undefined
Returns MaybePromise<void, IsAsync>
- Defined in src/simplestreams/dynamicSource.ts:51