fullstack-test-server - v1.0.0 › Globals › CustomCronJob

• CronJob

  ↳ CustomCronJob

• constructor

• cronTime
• fireOnTick
• logger
• options
• running
• started

• addCallback
• lastDate
• log
• logOnCreate
• logOnDestroy
• logOnTick
• nextDate
• nextDates
• setTime
• start
• stop

+ new CustomCronJob(options: ICustomCronJobParams): CustomCronJob

Overrides void

Defined in src/cron.jobs.ts:23

Parameters:

Name	Type
options	ICustomCronJobParams

Returns: CustomCronJob

• cronTime: CronTime

Defined in src/cron.jobs.ts:23

---

• fireOnTick: Function = this.logOnTick(super.fireOnTick)

Overrides void

Defined in src/cron.jobs.ts:56

---

• logger: IServerLogger = getLogger()

Defined in src/cron.jobs.ts:20

---

• options: ICustomCronJobParams

Defined in src/cron.jobs.ts:22

---

• running: boolean | undefined

Inherited from CustomCronJob.running

Defined in node_modules/@types/cron/index.d.ts:83

Return true if job is running.

---

• started: boolean = false

Defined in src/cron.jobs.ts:21

▸ addCallback(callback: Function): void

Inherited from CustomCronJob.addCallback

Defined in node_modules/@types/cron/index.d.ts:140

Add another onTick function.

Parameters:

Name	Type	Description
callback	Function	Target function.

Returns: void

---

▸ lastDate(): Date

Inherited from CustomCronJob.lastDate

Defined in node_modules/@types/cron/index.d.ts:124

Tells you the last execution date.

Returns: Date

---

▸ log(message: any): void

Defined in src/cron.jobs.ts:35

Parameters:

Name	Type
message	any

Returns: void

---

▸ logOnCreate(): void

Defined in src/cron.jobs.ts:47

Returns: void

---

▸ logOnDestroy(): void

Defined in src/cron.jobs.ts:52

Returns: void

---

▸ logOnTick(onTick: Function): Function

Defined in src/cron.jobs.ts:39

Parameters:

Name	Type
onTick	Function

Returns: Function

---

▸ nextDate(): Moment

Inherited from CustomCronJob.nextDate

Defined in node_modules/@types/cron/index.d.ts:128

Tells you when a CronTime will be run.

Returns: Moment

---

▸ nextDates(): Moment

Inherited from CustomCronJob.nextDates

Defined in node_modules/@types/cron/index.d.ts:129

Returns: Moment

▸ nextDates(i?: number): Moment | Moment[]

Inherited from CustomCronJob.nextDates

Defined in node_modules/@types/cron/index.d.ts:135

Tells you when a CronTime will be run.

Parameters:

Name	Type	Description
i?	number	Indicate which turn of run after now. If not given return next run time.

Returns: Moment | Moment[]

A Moment when the cronTime passed in the constructor is a Date or a Moment and an array of Moment when the cronTime is a string

---

▸ setTime(time: CronTime): void

Inherited from CustomCronJob.setTime

Defined in node_modules/@types/cron/index.d.ts:120

Change the time for the CronJob.

Parameters:

Name	Type	Description
time	CronTime	Target time.

Returns: void

---

▸ start(): void

Overrides void

Defined in src/cron.jobs.ts:58

Returns: void

---

▸ stop(): void

Overrides void

Defined in src/cron.jobs.ts:64

Returns: void