Class StreamInstance<Chunk, Err>

Type parameters

Chunk: string | Buffer
Err = any

Hierarchy

Instance<Chunk, Err>
- StreamInstance

Implements

Stream<Chunk, Err>
StreamEventEmitter<Chunk, Err>
StreamDatabase<Chunk, Err>

Index

Interfaces

ConstructorOptions

Properties

Methods

Properties

Readonly asyncEmit

asyncEmit: EmitFunc<Promise<void>, Chunk, Err>

Readonly emit

emit: EmitFunc<void, Chunk, Err>

Readonly on

on: EventedStream.ListenerModifier<Chunk, Err>

Readonly once

once: EventedStream.ListenerModifier<Chunk, Err>

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterator<Chunk>

Implementation of Stream.[Symbol.asyncIterator]

Inherited from IterableReadableStream.[Symbol.asyncIterator]
- Defined in node_modules/.pnpm/typescript@4.0.2/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:40
Returns AsyncIterator<Chunk>

getChunks

getChunks(): ReadonlyArray<Chunk>

Implementation of StreamDatabase.getChunks

Inherited from StreamDatabase.getChunks
- Defined in packages/simple-fake-stream/stream.ts:71
Get chunks that has been passed to .write()

Returns ReadonlyArray<Chunk>

Array of recorded chunks

getMethodCalls

getMethodCalls(): ReadonlyArray<MethodCall<Chunk, Err>>

Implementation of StreamDatabase.getMethodCalls

Inherited from StreamDatabase.getMethodCalls
- Defined in packages/simple-fake-stream/stream.ts:65
Get recorded method calls

Returns ReadonlyArray<MethodCall<Chunk, Err>>

Array of recorded method calls

write

write(chunk: Chunk): void

Implementation of Stream.write

Inherited from WritableStream.write
- Defined in packages/simple-fake-stream/stream.ts:29
Parameters
- chunk: Chunk
Returns void

Generated using TypeDoc