Job

Defined in: packages/client/src/jobs/job.ts:7

A registered job: run it now, pause and resume it, read its last and next run. Built from a JobBuilder by the client.

Constructors

Constructor

new Job(client, definition): Job;

Defined in: packages/client/src/jobs/job.ts:26

Parameters

client

Client

Owning client

definition

JobDefinition

Built by JobBuilder

Returns

Job

Properties

client

readonly client: Client;

Defined in: packages/client/src/jobs/job.ts:8

name

readonly name: string;

Defined in: packages/client/src/jobs/job.ts:9

Accessors

lastRun

Get Signature

get lastRun(): Date | null;

Defined in: packages/client/src/jobs/job.ts:40

Returns

Date | null

nextRun

Get Signature

get nextRun(): Date | null;

Defined in: packages/client/src/jobs/job.ts:44

Returns

Date | null

paused

Get Signature

get paused(): boolean;

Defined in: packages/client/src/jobs/job.ts:36

Returns

boolean

running

Get Signature

get running(): boolean;

Defined in: packages/client/src/jobs/job.ts:32

Returns

boolean

Methods

pause()

pause(): void;

Defined in: packages/client/src/jobs/job.ts:53

Returns

void

resume()

resume(): void;

Defined in: packages/client/src/jobs/job.ts:58

Returns

void

run()

run(): Promise<void>;

Defined in: packages/client/src/jobs/job.ts:49

Returns

Promise<void>