Class JobRunner

Hierarchy

AbstractTask<RunnerResult>
- JobRunner

Index

Constructors

Properties

Methods

execute getInfo gracefulTerminate onActivity onError onExecute onFinished onScheduled onStarted pause resume runJob schedule unschedule

Constructors

constructor

new JobRunner(job: JobModel, setup: JobRunnerSetup): JobRunner
Parameters
- job: JobModel
- setup: JobRunnerSetup
Returns JobRunner
Overrides AbstractTask<RunnerResult>.constructor
- Defined in tasks/JobRunner.ts:17

Properties

job

job: JobModel

setup

setup: JobRunnerSetup

Methods

execute

execute<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Inherited from AbstractTask.execute
- Defined in tasks/AbstractTask.ts:85

getInfo

getInfo(): TaskInfo
Returns TaskInfo
Inherited from AbstractTask.getInfo
- Defined in tasks/AbstractTask.ts:75

gracefulTerminate

gracefulTerminate(timeout?: number): Promise<void>
Parameters
- timeout: number = 500
Returns Promise<void>
Inherited from AbstractTask.gracefulTerminate
- Defined in tasks/AbstractTask.ts:113

onActivity

onActivity(cb: (action: string, path: string, count: number) => void): void
Parameters
- cb: (action: string, path: string, count: number) => void
Returns void
- Defined in tasks/JobRunner.ts:23

onError

onError(cb: (error: Error) => void): void
Parameters
- cb: (error: Error) => void
Returns void
Inherited from AbstractTask.onError
- Defined in tasks/AbstractTask.ts:109

onExecute

onExecute(cb: () => void): void
Parameters
- cb: () => void
Returns void
Inherited from AbstractTask.onExecute
- Defined in tasks/AbstractTask.ts:97

onFinished

onFinished<T>(cb: (result: T) => void): void
Type Parameters
- T
Parameters
- cb: (result: T) => void
Returns void
Inherited from AbstractTask.onFinished
- Defined in tasks/AbstractTask.ts:105

onScheduled

onScheduled(cb: () => void): void
Parameters
- cb: () => void
Returns void
Inherited from AbstractTask.onScheduled
- Defined in tasks/AbstractTask.ts:93

onStarted

onStarted(cb: () => void): void
Parameters
- cb: () => void
Returns void
Inherited from AbstractTask.onStarted
- Defined in tasks/AbstractTask.ts:101

pause

pause(): void
Returns void
Inherited from AbstractTask.pause
- Defined in tasks/AbstractTask.ts:67

resume

resume(): void
Returns void
Inherited from AbstractTask.resume
- Defined in tasks/AbstractTask.ts:71

runJob

runJob(): Promise<RunnerResult>
Returns Promise<RunnerResult>
- Defined in tasks/JobRunner.ts:27

schedule

schedule(runImmediately?: boolean): void
Parameters
- runImmediately: boolean = false
Returns void
Inherited from AbstractTask.schedule
- Defined in tasks/AbstractTask.ts:55

unschedule

unschedule(): void
Returns void
Inherited from AbstractTask.unschedule
- Defined in tasks/AbstractTask.ts:61