Interface InStream<In>

An InStream represents the interface for handling a readable stream

Type Parameters

In

The type of the messages being sent into the stream

Hierarchy

InStream

Index

Properties

addListener mapIn on removeListener

Properties

addListener

addListener: ((listener: StreamListener<In>) => void)

Type declaration

- (listener: StreamListener<In>): void
- Adds a listener for message, error, and/or completion events coming in
  Parameters
  - listener: StreamListener<In>
  Returns void

mapIn

mapIn: (<In2>(fn: ((input: In2) => In)) => InStream<In2>)

Type declaration

- <In2>(fn: ((input: In2) => In)): InStream<In2>
- Creates a new InStream of a different type by converting all of its input values to this streams input values
  Type Parameters
  - In2
    
    The object type being sent along InStream
  Parameters
  - fn: ((input: In2) => In)
    
    The method used to map between the two stream objects
    - (input: In2): In
      
      Parameters
      
      input: In2
      
      Returns In
  Returns InStream<In2>

on

on: ((eventType: "error" | "message" | "close", fn: ErrorFn | CloseFn | MessageFn<In>) => void)

Type declaration

- (eventType: "error" | "message" | "close", fn: ErrorFn | CloseFn | MessageFn<In>): void
- shortcut for adding a listener of a single type.
  
  Example
```
foo.on("close", () => console.log("closed") );
// is equivalent to
foo.addListener({onClose: () => console.log("closed")});
```
  Parameters
  - eventType: "error" | "message" | "close"
    
    Which of three valid events to listen for
  - fn: ErrorFn | CloseFn | MessageFn<In>
    
    callback that is called
  Returns void

removeListener

removeListener: ((listener: StreamListener<In>) => void)

Type declaration

- (listener: StreamListener<In>): void
- Removes a listener added by addListener
  Parameters
  - listener: StreamListener<In>
  Returns void

Generated using TypeDoc