Class Stream<T>

A Stream implements both InStream and OutStream in such a way that the output events of OutStream trigger the input events of InStream

Type Parameters

T

type of objects being transmitted along the stream

Hierarchy

Stream

Implements

StreamHandler<T, T>

Index

Constructors

Properties

Methods

addListener close error mapIn mapOut on removeListener write

Constructors

constructor

new Stream<T>(): Stream<T>
Type Parameters
- T
Returns Stream<T>

Properties

`Private` listeners

listeners: StreamListener<T>[] = []

Methods

addListener

addListener(listener: StreamListener<T>): void
Adds a StreamListener to handle any of the output events
Parameters
- listener: StreamListener<T>
Returns void
Implementation of StreamHandler.addListener
- Defined in estuary-rpc/stream.ts:129

close

close(): void
Invokes any registered close listeners

Returns void
Implementation of StreamHandler.close
- Defined in estuary-rpc/stream.ts:125

error

error(err: Error): void
Invokes any registered error listeners
Parameters
- err: Error
Returns void
Implementation of StreamHandler.error
- Defined in estuary-rpc/stream.ts:121

mapIn

mapIn<S>(fn: ((t: S) => T)): Stream<S>
Returns
a new Stream which is will write to this one whenever it is written to
Type Parameters
- S
Parameters
- fn: ((t: S) => T)
  
  Method to convert between the type of this stream and the returned stream type
  - - (t: S): T
    - Parameters
      
      t: S
      
      Returns T
Returns Stream<S>
Implementation of StreamHandler.mapIn
- Defined in estuary-rpc/stream.ts:171

mapOut

mapOut<S>(fn: ((t: T) => S)): Stream<S>
Returns
a new Stream which is written to whenever this stream is written to
Type Parameters
- S
Parameters
- fn: ((t: T) => S)
  
  Method to convert between the type of this stream and the returned stream type
  - - (t: T): S
    - Parameters
      
      t: T
      
      Returns S
Returns Stream<S>
Implementation of StreamHandler.mapOut
- Defined in estuary-rpc/stream.ts:158

on

on(eventType: "error" | "message" | "close", fn: ErrorFn | CloseFn | MessageFn<T>): void
Adds a specific flavor of StreamListener
Parameters
- eventType: "error" | "message" | "close"
- fn: ErrorFn | CloseFn | MessageFn<T>
Returns void
Implementation of StreamHandler.on
- Defined in estuary-rpc/stream.ts:138

removeListener

removeListener(listener: StreamListener<T>): void
Removes the listener if it had been added
Parameters
- listener: StreamListener<T>
Returns void
Implementation of StreamHandler.removeListener
- Defined in estuary-rpc/stream.ts:133

write

write(t: T): void
Invokes any registerd message listeners
Parameters
- t: T
Returns void
Implementation of StreamHandler.write
- Defined in estuary-rpc/stream.ts:117

Generated using TypeDoc