Class StdoutIterator

Iterate TapjawMessages from implemented adapter, convert each to JSON and write to the STDOUT buffer.

Hierarchy-Diagram

UML class diagram of StdoutIterator

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for a protected property in the UML class diagram

protected property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

italic abstract property/method

Hierarchy

OutputIterator
- StdoutIterator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StdoutIterator(writeCallback: WritableStream): StdoutIterator

Overrides OutputIterator.constructor
- Defined in src/iterators/stdout-iterator.ts:11
Parameters
- writeCallback: WritableStream
Returns StdoutIterator

Properties

Protected pretty

pretty: boolean = false

Protected Readonly writeCallback

writeCallback: WritableStream

Methods

Protected outputMessage

outputMessage(message: TapjawMessage): Promise<void>

Overrides OutputIterator.outputMessage
- Defined in src/iterators/stdout-iterator.ts:29
Write message to STDOUT.

Parameters
- message: TapjawMessage
  
  TapjawMessage
Returns Promise<void>

run

run(adapterCallback: TapjawAdapterCallback<TapjawMessage>, limit?: number): Promise<void>

Inherited from OutputIterator.run
- Defined in src/iterators/output-iterator.ts:14
This primary method must perform an iteration over the Adapter's generator to yield responses and push each individual TapjawMessage from the Adapter to an output interface.

Parameters
- adapterCallback: TapjawAdapterCallback<TapjawMessage>
- Optional limit: number
Returns Promise<void>
Promise

setPretty

setPretty(polarity: boolean): void

- Defined in src/iterators/stdout-iterator.ts:20
Whether to output the JSON with pretty indentation and newlines.

Parameters
- polarity: boolean
  
  boolean
Returns void

Generated using TypeDoc