Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TaskRunner

Container for single or multiple task execution

Events:

  • TASKRUN_STATE_FINISHED
  • TASKRUN_STATE_NEXT
  • TASKRUN_STATE_RUN
  • TASKRUN_STATE_DONE

Hierarchy

  • EventEmitter
    • TaskRunner

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

$dry_mode

$dry_mode: any

$duration

$duration: number

$finish

$finish: Function = null

$finished

$finished: any

$incoming

$incoming: any = {}

$options

$options: ITaskRunnerOptions

$outgoing

$outgoing: any = {}

$parallel

$parallel: any

$registry

$registry: Tasks

$start

$start: Date

$stop

$stop: Date

$tasks

$tasks: TaskRun[] = []

Private doneNrs

doneNrs: number[]

event

event: TaskRunnerEvent

id

id: string

Private invoker

invoker: Invoker

Private loggerName

loggerName: string

nr

nr: number = ...

readStream

readStream: Readable

Private runningNrs

runningNrs: number[]

state

state: TASK_STATES = 'proposed'

Private taskLogger

taskLogger: ILoggerApi

taskNrs

taskNrs: number = 0

Private todoNrs

todoNrs: number[] = []

writeStream

writeStream: Writable

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static taskRunnerId

taskRunnerId: number = 0

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

api

areTasksDone

  • areTasksDone(tasksNrs: number[]): boolean

collectStats

createTaskRun

  • createTaskRun(name: string, incomings?: any): TaskRun

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

enqueue

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

finalize

  • finalize(): Promise<void>

finish

  • finish(): void

fireStateEvent

  • fireStateEvent(): void

getId

  • getId(): string

getList

  • getList(): string[]

getLogger

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getOption

  • getOption(key: string, defaultValue?: any): any

getOptions

  • getOptions(): ITaskRunnerOptions

getReadStream

  • getReadStream(): Readable

getRequiredIncomings

getTaskNames

  • getTaskNames(): string[]

getWriteStream

  • getWriteStream(): Writable

Private initStreams

  • initStreams(): void

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

next

  • next(): void

off

  • off(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

on

  • on(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

once

  • once(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): TaskRunner

  • Parameters

    • Optional event: string | symbol

    Returns TaskRunner

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): TaskRunner

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TaskRunner

resolveDeps

run

runDry

selectNextTask

setIncoming

  • setIncoming(key: string, value: any): Promise<void>

setMaxListeners

  • Parameters

    • n: number

    Returns TaskRunner

taskDone

  • taskDone(taskRun: TaskRun, err?: Error): void

taskInc

  • taskInc(): number

taskRun

update

  • update(taskName: string): void

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc