Class TapjawFilterCommand<T, M> Abstract

Type parameters

T: TapjawCommandFlags
M: TapjawMessage

Hierarchy-Diagram

UML class diagram of TapjawFilterCommand

Legend

icon for an abstract class in the UML class diagram

abstract class

icon for an interface in the UML class diagram

interface

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

underlined static property/method

italic abstract property/method

Hierarchy

TapjawFilterCommand

Implements

TapjawCommand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TapjawFilterCommand<T, M>(stdin: ReadableStream, stdout: WritableStream, displayJsonParseErrors?: boolean): TapjawFilterCommand<T, M>

- Defined in src/commands/tapjaw-filter-command.ts:15
Type parameters
- T: TapjawCommandFlags<unknown>
- M: TapjawMessage<M>
Parameters
- stdin: ReadableStream
- stdout: WritableStream
- displayJsonParseErrors: boolean = false
Returns TapjawFilterCommand<T, M>

Properties

Protected Readonly displayJsonParseErrors

displayJsonParseErrors: boolean = false

Protected Readonly stdin

stdin: ReadableStream

Protected Readonly stdout

stdout: WritableStream

Methods

Protected emit

emit(message: M): void

- Defined in src/commands/tapjaw-filter-command.ts:55
Parameters
- message: M
Returns void

Protected onBeforeExit

onBeforeExit(args: TapjawCommandArgs<unknown>, flags: T): Promise<void>

- Defined in src/commands/tapjaw-filter-command.ts:62
Parameters
- args: TapjawCommandArgs<unknown>
- flags: T
Returns Promise<void>

Protected Abstract onMessageFilter

onMessageFilter(message: M, args: TapjawCommandArgs<unknown>, flags: T): Promise<null | M>

- Defined in src/commands/tapjaw-filter-command.ts:59
Parameters
- message: M
- args: TapjawCommandArgs<unknown>
- flags: T
Returns Promise<null | M>

run

run(args: TapjawCommandArgs<unknown>, flags: T): Promise<void>

Implementation of TapjawCommand.run
- Defined in src/commands/tapjaw-filter-command.ts:25
Run the command the execute the iterator run routine.

Parameters
- args: TapjawCommandArgs<unknown>
- flags: T
Returns Promise<void>

Static Protected getLogger

getLogger(): TapjawLogger

- Defined in src/commands/tapjaw-filter-command.ts:70
Returns TapjawLogger

Static register

register(program: Command): void

- Defined in src/commands/tapjaw-filter-command.ts:66
Parameters
- program: Command
Returns void

Generated using TypeDoc