Documentation

Documentation / @zerotal/scheduler / SchedulerBuilder

Class: SchedulerBuilder

Defined in: scheduler/src/SchedulerManager.ts:39

Constructors

Constructor

new SchedulerBuilder(_manager, _name, _callback): SchedulerBuilder

Defined in: scheduler/src/SchedulerManager.ts:40

Parameters

_manager

SchedulerManager

_name

string

_callback

TaskCallback

Returns

SchedulerBuilder

Methods

cron()

cron(expression): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:51

Parameters

expression

string

Returns

ScheduledTask

everySecond()

everySecond(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:55

Returns

ScheduledTask

everyTwoSeconds()

everyTwoSeconds(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:58

Returns

ScheduledTask

everyFiveSeconds()

everyFiveSeconds(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:61

Returns

ScheduledTask

everyTenSeconds()

everyTenSeconds(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:64

Returns

ScheduledTask

everyThirtySeconds()

everyThirtySeconds(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:67

Returns

ScheduledTask

everyMinute()

everyMinute(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:71

Returns

ScheduledTask

everyTwoMinutes()

everyTwoMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:74

Returns

ScheduledTask

everyThreeMinutes()

everyThreeMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:77

Returns

ScheduledTask

everyFourMinutes()

everyFourMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:80

Returns

ScheduledTask

everyFiveMinutes()

everyFiveMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:83

Returns

ScheduledTask

everyTenMinutes()

everyTenMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:86

Returns

ScheduledTask

everyFifteenMinutes()

everyFifteenMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:89

Returns

ScheduledTask

everyThirtyMinutes()

everyThirtyMinutes(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:92

Returns

ScheduledTask

hourly()

hourly(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:96

Returns

ScheduledTask

hourlyAt()

hourlyAt(minute): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:99

Parameters

minute

number

Returns

ScheduledTask

everyOddHour()

everyOddHour(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:102

Returns

ScheduledTask

daily()

daily(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:105

Returns

ScheduledTask

dailyAt()

dailyAt(time): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:108

Parameters

time

string

Returns

ScheduledTask

twiceDaily()

twiceDaily(first?, second?): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:112

Parameters

first?

number = 1

second?

number = 13

Returns

ScheduledTask

weekdays()

weekdays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:116

Returns

ScheduledTask

weekends()

weekends(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:119

Returns

ScheduledTask

sundays()

sundays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:122

Returns

ScheduledTask

mondays()

mondays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:125

Returns

ScheduledTask

tuesdays()

tuesdays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:128

Returns

ScheduledTask

wednesdays()

wednesdays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:131

Returns

ScheduledTask

thursdays()

thursdays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:134

Returns

ScheduledTask

fridays()

fridays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:137

Returns

ScheduledTask

saturdays()

saturdays(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:140

Returns

ScheduledTask

days()

days(daysOfWeek): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:143

Parameters

daysOfWeek

number[]

Returns

ScheduledTask

weekly()

weekly(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:147

Returns

ScheduledTask

twiceWeekly()

twiceWeekly(first?, second?): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:150

Parameters

first?

number = 1

second?

number = 4

Returns

ScheduledTask

monthly()

monthly(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:153

Returns

ScheduledTask

twiceMonthly()

twiceMonthly(first?, second?): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:156

Parameters

first?

number = 1

second?

number = 16

Returns

ScheduledTask

lastDayOfMonth()

lastDayOfMonth(time?): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:159

Parameters

time?

string = "00:00"

Returns

ScheduledTask

quarterly()

quarterly(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:168

Returns

ScheduledTask

quarterlyOn()

quarterlyOn(dayOfMonth?, time?): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:171

Parameters

dayOfMonth?

number = 1

time?

string = "00:00"

Returns

ScheduledTask

yearly()

yearly(): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:175

Returns

ScheduledTask

yearlyOn()

yearlyOn(month?, dayOfMonth?, time?): ScheduledTask

Defined in: scheduler/src/SchedulerManager.ts:178

Parameters

month?

number = 1

dayOfMonth?

number = 1

time?

string = "00:00"

Returns

ScheduledTask