@sms/plugin-scheduler

Interfaces

Schedule

Defined in: packages/plugins/scheduler/src/contract.ts:6

@sms/plugin-scheduler/contract — the definitions other plugins depend on: the scheduler key, the schedule point, job / tick / service types and the validator. No manifest, no plugin body (schedulerPlugin lives in index.ts).

Properties

description?

optional description?: string;

Defined in: packages/plugins/scheduler/src/contract.ts:9

everyMs

everyMs: number;

Defined in: packages/plugins/scheduler/src/contract.ts:11

Minimum interval between runs. A job first runs on the first tick after it is contributed.

handler

handler: (run) => unknown;

Defined in: packages/plugins/scheduler/src/contract.ts:12

Parameters

Returns

unknown

name

name: string;

Defined in: packages/plugins/scheduler/src/contract.ts:8

Unique across all plugins.

ScheduledJob

Defined in: packages/plugins/scheduler/src/contract.ts:15

Properties

description?

optional description?: string;

Defined in: packages/plugins/scheduler/src/contract.ts:18

everyMs

everyMs: number;

Defined in: packages/plugins/scheduler/src/contract.ts:19

lastError?

optional lastError?: string;

Defined in: packages/plugins/scheduler/src/contract.ts:21

lastRun?

optional lastRun?: number;

Defined in: packages/plugins/scheduler/src/contract.ts:20

name

name: string;

Defined in: packages/plugins/scheduler/src/contract.ts:16

owner

owner: string;

Defined in: packages/plugins/scheduler/src/contract.ts:17

SchedulerService

Defined in: packages/plugins/scheduler/src/contract.ts:32

Methods

jobs()

jobs(): ScheduledJob[];

Defined in: packages/plugins/scheduler/src/contract.ts:35

Returns

ScheduledJob[]

tick()

tick(now?): Promise<TickResult>;

Defined in: packages/plugins/scheduler/src/contract.ts:34

Run every due job. now defaults to Date.now(); jobs run one at a time.

Parameters

Returns

Promise<TickResult>

TickResult

Defined in: packages/plugins/scheduler/src/contract.ts:24

Properties

failed

failed: {
  error: string;
  name: string;
}[];

Defined in: packages/plugins/scheduler/src/contract.ts:29

Jobs that threw; the error is also kept on jobs() and logged.

error

error: string;

name

name: string;

now

now: number;

Defined in: packages/plugins/scheduler/src/contract.ts:25

ran

ran: string[];

Defined in: packages/plugins/scheduler/src/contract.ts:27

Names of the jobs that ran, in order.

Variables

SCHEDULE_POINT

const SCHEDULE_POINT: "schedule" = 'schedule';

Defined in: packages/plugins/scheduler/src/contract.ts:39

SCHEDULER_KEY

const SCHEDULER_KEY: "scheduler" = 'scheduler';

Defined in: packages/plugins/scheduler/src/contract.ts:38

schedulerPlugin

const schedulerPlugin: SystemPlugin;

Defined in: packages/plugins/scheduler/src/index.ts:25

Functions

validateSchedule()

function validateSchedule(item): void;

Defined in: packages/plugins/scheduler/src/contract.ts:42

Parameters

Returns

void