Class JobLoader

Hierarchy

AbstractTask<Job[]>
- JobLoader

Index

Constructors

Properties

Methods

execute getInfo gracefulTerminate loadJobs onceLoaded onError onExecute onFinished onJobDeleted onJobLoaded onLoadingError onScheduled onStarted pause resume schedule unschedule

Constructors

constructor

new JobLoader(options?: { configDir?: string }): JobLoader
Parameters
- options: { configDir?: string } = {}
  - OptionalconfigDir?: string
    Configuration directory where ./jobs and ./scripts are located. Defaults to ./config
Returns JobLoader
Overrides AbstractTask<Job[]>.constructor
- Defined in tasks/JobLoader.ts:21

Properties

configDir

configDir: string

Methods

execute

execute(): Promise<Job[]>
Returns Promise<Job[]>
Inherited from AbstractTask.execute
- Defined in tasks/AbstractTask.ts:87

getInfo

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

gracefulTerminate

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

loadJobs

loadJobs(): Promise<Job[]>
Returns Promise<Job[]>
- Defined in tasks/JobLoader.ts:27

onceLoaded

onceLoaded(cb: (jobs: Job[]) => void): void
Parameters
- cb: (jobs: Job[]) => void
Returns void
- Defined in tasks/JobLoader.ts:31

onError

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

onExecute

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

onFinished

onFinished(cb: (result: Job[]) => void): void
Parameters
- cb: (result: Job[]) => void
Returns void
Inherited from AbstractTask.onFinished
- Defined in tasks/AbstractTask.ts:107

onJobDeleted

onJobDeleted(cb: (jobId: string) => void): void
Parameters
- cb: (jobId: string) => void
Returns void
- Defined in tasks/JobLoader.ts:43

onJobLoaded

onJobLoaded(cb: (job: Job, isReload: boolean) => void): void
Parameters
- cb: (job: Job, isReload: boolean) => void
Returns void
- Defined in tasks/JobLoader.ts:39

onLoadingError

onLoadingError(cb: (jobId: string, message: string) => void): void
Parameters
- cb: (jobId: string, message: string) => void
Returns void
- Defined in tasks/JobLoader.ts:35

onScheduled

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

onStarted

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

pause

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

resume

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

schedule

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

unschedule

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