import Scheduler from '@moqada/hubot-schedule-helper/src/Scheduler.js'

public class | source

Scheduler

Test:

Scheduler

Constructor Summary

Public Constructor
public	constructor(params: Object) Constructor

Member Summary

Public Members
public	JobCls: Job Job class
public	jobMaxCount: number Max number of jobs
public	jobs: Object Job list
public	robot: Object Hubot robot object
public	storeKey: string key of Hubot brain

Method Summary

Public Methods
public	cancelJob(id: number) Cancel Job
public	createCronJob(params: Object): Job Create new CronJob
public	createDateJob(params: Object): Job Create new DateJob
public	createId(): number Create Job id
public	createJob(params: Object): Job Create new Job
public	createJobFromBrain(id: number, data: Object): Job Create new Job from brain
public	initBrain() Initialize Hubot brain
public	storeJobToBrain(id: number, job: Job) Store Job to brain
public	syncBrain() Sync Jobs from Brain
public	updateJob(id: number, meta: Object) Update existes Job

Public Constructors

public constructor(params: Object) source

Constructor

Params:

Name	Type	Attribute	Description
params	Object		params
params.robot	Object		Hubot robot object
params.storeKey	string		key of Hubot brain
params.job	Object		Job class
params.jobMaxCount	number	optional default: 10000	max number of jobs

Test:

Scheduler constructor()

Public Members

public JobCls: Job source

Job class

public jobMaxCount: number source

Max number of jobs

public jobs: Object source

Job list

public robot: Object source

Hubot robot object

public storeKey: string source

key of Hubot brain

Public Methods

public cancelJob(id: number) source

Cancel Job

Params:

Name	Type	Attribute	Description
id	number		Job id

Test:

Scheduler #cancelJob()

public createCronJob(params: Object): Job source

Create new CronJob

Params:

Name	Type	Attribute	Description
params	Object		params
params.pattern	string		Cron pattern
params.user	Object		Target Hubot user
params.meta	Object		Data for using Job
params.id	number		Job id

Return:

Job

public createDateJob(params: Object): Job source

Create new DateJob

Params:

Name	Type	Attribute	Description
params	Object		params
params.pattern	string		Date string
params.user	Object		Target Hubot user
params.meta	Object		Data for using Job
params.id	number		Job id

Return:

Job

public createId(): number source

Create Job id

Return:

number

public createJob(params: Object): Job source

Create new Job

Params:

Name	Type	Attribute	Description
params	Object		params
params.pattern	string		Cron pattern or Date string
params.user	Object		Target Hubot user
params.meta	Object		data for using Job
params.id	number	optional	Job id