0.0.3 • Published 7 years ago
@framorim/teatime v0.0.3
TeaTime
TeaTime is a simple Job Schedule for NodeJS. Don't miss your tea!
Installation:
npm install @framorim/teatime --saveor
npm install -g @framorim/teatimeUsage:
Import the module into your project
const TeaTime = require('@framorim/teatime')Create a new TeaTime
const schedule = new TeaTime();const options = {
hour: 3,
weekday: '*'
};
schedule.addJob('<JOB_NAME>', options, async () => {
/*...YOUR LOGIC GOES HERE ...*/
});Specifications:
Methods:
| Methods | Description | Ready |
|---|---|---|
| addJob() | Creates a job in the manager | ✓ |
| stopJob() | Only stops a job in the manager | ✓ |
| deleteJob() | Deletes a job from the manager | ✓ |
| setJob() | Sets a job in the manager | ✓ |
| restartJob() | Restarts job in the manager | ✓ |
Options:
| Option | Description |
|---|---|
| minute | Represents minute in numbers |
| hour | Represents hour in numbers |
| weekday | Represents weekday in numbers |