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:19

Properties

job

job: JobModel

setup

setup: JobRunnerSetup

Methods

execute

execute(): Promise<
    {
        archived: number;
        copied: number;
        deleted: number;
        durationMs: number;
        endTime: number;
        errors: number;
        executed: number;
        pruned: number;
        startTime: number;
    },
>
Returns Promise<
    {
        archived: number;
        copied: number;
        deleted: number;
        durationMs: number;
        endTime: number;
        errors: number;
        executed: number;
        pruned: number;
        startTime: number;
    },
>
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

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:25

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: {
            archived: number;
            copied: number;
            deleted: number;
            durationMs: number;
            endTime: number;
            errors: number;
            executed: number;
            pruned: number;
            startTime: number;
        },
    ) => void,
): void
Parameters
- cb: (
      result: {
          archived: number;
          copied: number;
          deleted: number;
          durationMs: number;
          endTime: number;
          errors: number;
          executed: number;
          pruned: number;
          startTime: number;
      },
  ) => void
Returns void
Inherited from AbstractTask.onFinished
- Defined in tasks/AbstractTask.ts:107

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

runJob

runJob(): Promise<
    {
        archived: number;
        copied: number;
        deleted: number;
        durationMs: number;
        endTime: number;
        errors: number;
        executed: number;
        pruned: number;
        startTime: number;
    },
>
Returns Promise<
    {
        archived: number;
        copied: number;
        deleted: number;
        durationMs: number;
        endTime: number;
        errors: number;
        executed: number;
        pruned: number;
        startTime: number;
    },
>
- Defined in tasks/JobRunner.ts:29

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

Class JobRunner

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns JobRunner

Properties

job

setup

Methods

execute

Returns Promise< { archived: number; copied: number; deleted: number; durationMs: number; endTime: number; errors: number; executed: number; pruned: number; startTime: number; },>

getInfo

Returns TaskInfo

gracefulTerminate

Parameters

Returns Promise<void>

onActivity

Parameters

Returns void

onError

Parameters

Returns void

onExecute

Parameters

Returns void

onFinished

Parameters

Returns void

onScheduled

Parameters

Returns void

onStarted

Parameters

Returns void

pause

Returns void

resume

Returns void

runJob

Returns Promise< { archived: number; copied: number; deleted: number; durationMs: number; endTime: number; errors: number; executed: number; pruned: number; startTime: number; },>

schedule

Parameters

Returns void

unschedule

Returns void

Settings

On This Page

Returns Promise<
{
archived: number;
copied: number;
deleted: number;
durationMs: number;
endTime: number;
errors: number;
executed: number;
pruned: number;
startTime: number;
},
>

Returns Promise<
{
archived: number;
copied: number;
deleted: number;
durationMs: number;
endTime: number;
errors: number;
executed: number;
pruned: number;
startTime: number;
},
>