Compare commits

..

26 Commits

Author SHA1 Message Date
da9c71eedb 3.0.42 2021-11-08 16:52:14 +01:00
63405fc577 fix(readme): fix readme 2021-11-08 16:52:13 +01:00
d789eec558 3.0.41 2021-11-08 16:49:33 +01:00
22027d2308 fix(update croner): update croner package, closes #1. Thank you @Hexagon4 2021-11-08 16:49:33 +01:00
87d29fbb50 3.0.40 2021-11-08 16:40:19 +01:00
1c5a1c21da fix(core): update 2021-11-08 16:40:19 +01:00
969088ad04 3.0.39 2021-10-06 11:58:36 +02:00
76768a1307 fix(core): update 2021-10-06 11:58:36 +02:00
419fe80bde 3.0.38 2021-01-02 19:30:16 +00:00
5a9584917c fix(core): update 2021-01-02 19:30:15 +00:00
2b21ee9a24 3.0.37 2020-10-05 22:28:40 +00:00
3a110c9fd9 fix(core): update 2020-10-05 22:28:40 +00:00
25f7ad37ae 3.0.36 2020-10-05 17:48:42 +00:00
992d167a34 fix(core): update 2020-10-05 17:48:41 +00:00
cfcfde2132 3.0.35 2020-09-07 23:44:08 +00:00
b5ab945501 fix(core): update 2020-09-07 23:44:07 +00:00
88378e2f31 3.0.34 2020-09-07 17:16:12 +00:00
db92311daa fix(core): update 2020-09-07 17:16:11 +00:00
36bff0a70a 3.0.33 2020-09-07 16:44:55 +00:00
fa8fd9fa35 fix(core): update 2020-09-07 16:44:54 +00:00
dd783b455f 3.0.32 2020-09-07 12:13:28 +00:00
996685e7fb fix(core): update 2020-09-07 12:13:27 +00:00
110b2c00cf 3.0.31 2020-09-04 15:18:41 +00:00
c8b455b8e2 fix(core): update 2020-09-04 15:18:41 +00:00
d16fd8b69b 3.0.30 2020-09-04 14:24:42 +00:00
f7ed88cd57 fix(core): update 2020-09-04 14:24:42 +00:00
15 changed files with 19505 additions and 3749 deletions

23010
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,33 +1,34 @@
{
"name": "@pushrocks/smarttime",
"private": false,
"version": "3.0.29",
"version": "3.0.42",
"description": "handle time in smart ways",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest ./test/)",
"test": "(tstest ./test)",
"build": "(tsbuild --web && tsbundle npm)"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsbundle": "^1.0.78",
"@gitzone/tsrun": "^1.2.12",
"@gitzone/tstest": "^1.0.44",
"@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^14.6.2",
"@gitzone/tsbuild": "^2.1.28",
"@gitzone/tsbundle": "^1.0.88",
"@gitzone/tsrun": "^1.2.18",
"@gitzone/tstest": "^1.0.60",
"@pushrocks/tapbundle": "^3.2.14",
"@types/node": "^16.11.6",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
},
"dependencies": {
"@pushrocks/lik": "^4.0.17",
"@pushrocks/smartdelay": "^2.0.10",
"@pushrocks/smartpromise": "^3.0.2",
"croner": "^1.1.23",
"dayjs": "^1.8.35",
"is-nan": "^1.3.0"
"@pushrocks/lik": "^5.0.0",
"@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartpromise": "^3.1.6",
"croner": "^4.0.69",
"dayjs": "^1.10.7",
"is-nan": "^1.3.2",
"pretty-ms": "^7.0.1"
},
"files": [
"ts/**/*",

View File

@ -36,7 +36,7 @@ This class provides scheduling of functions with a cron syntax
```typescript
import { CronManager } from '@pushrocks/smarrtime';
const cronManagerInstance = new CronManager();
cronManagerInstance.addConrjob('* * * * * *', async () => {
cronManagerInstance.addCronjob('* * * * * *', async () => {
console.log('hello'); // will log 'hello' to console once every second;
});
cronManagerInstance.start();

View File

@ -17,7 +17,7 @@ tap.test('should create a valid cronJon', async (tools) => {
let counter2 = 0;
let counter3 = 0;
const cronJob = testCronManager.addCronjob('*/2 * * * * *', async () => {
if (counter === 10) {
if (counter === 5) {
testCronManager.removeCronjob(cronJob);
done.resolve();
}
@ -25,7 +25,7 @@ tap.test('should create a valid cronJon', async (tools) => {
console.log(`${new Date().getSeconds()} hey ${counter} -> runs every 2 seconds`);
});
const cronJob2 = testCronManager.addCronjob('*/3 * * * * *', async () => {
if (counter2 === 10) {
if (counter2 === 5) {
testCronManager.removeCronjob(cronJob2);
done2.resolve();
}
@ -33,7 +33,7 @@ tap.test('should create a valid cronJon', async (tools) => {
console.log(`${new Date().getSeconds()} hey ${counter2} -> runs every 3 seconds`);
});
const cronJob3 = testCronManager.addCronjob('*/4 * * * * *', async () => {
if (counter3 === 10) {
if (counter3 === 5) {
done3.resolve();
}
counter3++;
@ -44,6 +44,17 @@ tap.test('should create a valid cronJon', async (tools) => {
await done2.promise;
await done3.promise;
testCronManager.stop();
testCronManager.removeCronjob(cronJob3);
});
tap.test('runs every full minute', async (tools) => {
const done = tools.defer();
const cronJob = testCronManager.addCronjob('0 * * * * *', async () => {
done.resolve();
});
testCronManager.start();
await done.promise;
testCronManager.stop();
});
tap.start();

View File

@ -1,27 +0,0 @@
import { tap, expect } from '@pushrocks/tapbundle';
import * as smarttime from '../ts/index';
let testCronManager: smarttime.CronManager;
tap.test('should create a valid instance of cronmanager', async () => {
testCronManager = new smarttime.CronManager();
expect(testCronManager).to.be.instanceOf(smarttime.CronManager);
});
tap.test('should create a valid cronJon', async (tools) => {
const done = tools.defer();
let counter = 0;
testCronManager.addCronjob('*/2 * * * * *', async () => {
if (counter === 10) {
done.resolve();
}
counter++;
console.log(`hey ${counter}`);
});
testCronManager.start();
await done.promise;
testCronManager.stop();
});
tap.start();

View File

@ -2,6 +2,11 @@ import { expect, tap } from '@pushrocks/tapbundle';
import * as smarttime from '../ts/index';
tap.test('should create a valid JavaScript Date', async () => {
const extendedDate = new smarttime.ExtendedDate(Date.now());
console.log(extendedDate);
});
tap.test('should create a valid JavaScript Date from European TimeStamp', async () => {
const extendedDate = smarttime.ExtendedDate.fromEuropeanDate('1.6.2018');
console.log(extendedDate);
@ -21,4 +26,9 @@ tap.test('should create a European date string', async () => {
expect(extendedDate.exportToEuropeanDate()).to.equal('13.02.2018');
});
tap.test('should format a date', async () => {
const extendedDate = new smarttime.ExtendedDate(Date.now());
console.log(extendedDate.format('YYYY-MM-DD - hh:mm'));
})
tap.start();

View File

@ -1,10 +1,12 @@
import * as plugins from './smarttime.plugins';
import { CronManager } from './smarttime.classes.cronmanager';
import { CronParser } from './smarttime.classes.cronparser';
export type TJobFunction = (() => void) | (() => Promise<any>);
export class CronJob {
public croner;
public cronParser: CronParser | typeof plugins.croner;
public status: 'started' | 'stopped' | 'initial' = 'initial';
public cronExpression: string;
public jobFunction: TJobFunction;
@ -13,7 +15,7 @@ export class CronJob {
constructor(cronManager: CronManager, cronExpressionArg: string, jobFunction: TJobFunction) {
this.cronExpression = cronExpressionArg;
this.jobFunction = jobFunction;
this.croner = plugins.croner(this.cronExpression);
this.cronParser = plugins.croner(cronExpressionArg);
}
/**
@ -41,7 +43,7 @@ export class CronJob {
* gets the time to next execution
*/
public getTimeToNextExecution() {
return this.croner.msToNext();
return this.cronParser.msToNext();
}
public start() {

View File

@ -1,5 +1,6 @@
import * as plugins from './smarttime.plugins';
import { CronJob } from './smarttime.classes.cronjob';
import { getMilliSecondsAsHumanReadableString } from './smarttime.units';
export class CronManager {
public executionTimeout: plugins.smartdelay.Timeout<void>;
@ -46,10 +47,20 @@ export class CronManager {
nextRunningCronjob = cronJob;
}
}
this.executionTimeout = new plugins.smartdelay.Timeout(nextRunningCronjob.getTimeToNextExecution());
console.log(
`Next CronJob scheduled in ${this.executionTimeout.getTimeLeft()} milliseconds`
);
if (nextRunningCronjob) {
this.executionTimeout = new plugins.smartdelay.Timeout(
nextRunningCronjob.getTimeToNextExecution()
);
console.log(
`Next CronJob scheduled in ${getMilliSecondsAsHumanReadableString(
this.executionTimeout.getTimeLeft()
)}`
);
} else {
this.executionTimeout = new plugins.smartdelay.Timeout(1000);
console.log('no cronjobs specified! Checking again in 1 second');
}
await this.executionTimeout.promise;
} while (this.status === 'started');
};

View File

@ -0,0 +1,88 @@
import * as plugins from './smarttime.plugins';
export class CronParser {
public cronExpression: string;
public get cronArray() {
return this.cronExpression.split(' ');
}
constructor(cronExpressionArg: string) {
this.cronExpression = cronExpressionArg;
if (this.cronArray.length < 6) {
throw new Error('CronParser needs second level accuracy');
}
}
private getNextPartMatch(cronPart: string, startValue: number, moduloArg: number) {
if (cronPart === '*') {
return startValue;
}
if (cronPart.includes('/')) {
const every = parseInt(cronPart.split('/')[1], 10);
const findEvenMatch = (recursionStartArg: number): number => {
if (recursionStartArg % every === 0) {
return recursionStartArg;
} else {
return findEvenMatch(recursionStartArg + 1);
}
};
return findEvenMatch(startValue);
}
if (parseInt(cronPart, 10) || cronPart === '0') {
const match = parseInt(cronPart, 10);
return match;
}
}
public msToNext() {
const cronArray = this.cronArray;
const secondExpression = cronArray[0];
const minuteExpression = cronArray[1];
const hourExpression = cronArray[2];
const dayExpression = cronArray[3];
const monthExpression = cronArray[4];
const yearExpression = cronArray[5];
let currentDate = new Date();
let currentSecond = currentDate.getSeconds() + 1;
let currentMinute = currentDate.getMinutes();
let currentHour = currentDate.getHours();
let currentDay = currentDate.getDate();
let currentMonth = currentDate.getMonth();
let currentYear = currentDate.getFullYear();
const targetSecond = this.getNextPartMatch(secondExpression, currentSecond, 59);
if (targetSecond < currentSecond) {
currentMinute = (currentMinute + 1) % 59;
}
const targetMinute = this.getNextPartMatch(minuteExpression, currentMinute, 59);
if (targetMinute < currentMinute) {
currentHour = (currentHour + 1) % 23;
}
const targetHour = this.getNextPartMatch(hourExpression, currentHour, 23);
if (targetHour < currentHour) {
currentDay = (currentDay + 1) % 30;
}
const targetDay = currentDay;
if (targetDay < currentDay) {
currentMonth = (currentMonth + 1) % 11;
}
const targetMonth = currentMonth;
if (targetMonth < currentMonth) {
currentYear = (currentYear + 1);
}
const targetYear = currentYear;
const targetDate = new Date(
targetYear,
targetMonth,
targetDay,
targetHour,
targetMinute,
targetSecond
);
const targetTime = targetDate.getTime();
return targetTime - Date.now();
}
}

View File

@ -1,4 +1,5 @@
import * as plugins from './smarttime.plugins';
import * as units from './smarttime.units';
export type TAvailableZone = 'Europe/Berlin';
@ -72,7 +73,7 @@ export class ExtendedDate extends Date {
// INSTANCE
public timezone: TAvailableZone;
constructor(unixMilli: number) {
constructor(unixMilli: number = Date.now()) {
super(unixMilli);
}
@ -121,4 +122,25 @@ export class ExtendedDate extends Date {
dayOfTheWeekName: daysArray[this.getDay()],
};
}
public format (formatArg: string) {
return plugins.dayjs(this.getTime()).format(formatArg);
}
/**
* boolean checks
*/
public isToday () {
return plugins.dayjs(this.getTime()).isToday();
}
public lessTimePassedToNow(unitArgs: units.IUnitCombinationArg): boolean {
const maxPassedUnixTime = units.getMilliSecondsFromUnits(unitArgs);
const actualPassedUnixTime = Date.now() - this.getTime();
return actualPassedUnixTime < maxPassedUnixTime;
}
public moreTimePassedToNow(unitArgs: units.IUnitCombinationArg) {
return !this.lessTimePassedToNow(unitArgs);
}
}

View File

@ -8,7 +8,7 @@ export class TimeStamp {
/**
* returns new TimeStamp from milliseconds
*/
public static fromMilliSeconds(milliSecondsArg) {
public static fromMilliSeconds(milliSecondsArg: number) {
return new TimeStamp(milliSecondsArg);
}

View File

@ -5,8 +5,12 @@ import * as smartpromise from '@pushrocks/smartpromise';
export { lik, smartdelay, smartpromise };
// third parties
import croner from 'croner';
// third parties;
const croner: any = require('croner');
import dayjs from 'dayjs';
import isToday from 'dayjs/plugin/isToday';
import prettyMs from 'pretty-ms';
export { croner, dayjs };
dayjs.extend(isToday);
export { croner, dayjs, prettyMs };

View File

@ -1,3 +1,5 @@
import * as plugins from './smarttime.plugins';
export let units = {
years: (timesArg = 1): number => {
return timesArg * 3.154e10;
@ -30,7 +32,7 @@ export interface IUnitCombinationArg {
export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
let timeInMilliseconds = 0;
let addMilliSeconds = (milliSecondsArg) => {
let addMilliSeconds = (milliSecondsArg: number) => {
timeInMilliseconds = timeInMilliseconds + milliSecondsArg;
};
if (combinationArg.years) {
@ -54,3 +56,7 @@ export let getMilliSecondsFromUnits = (combinationArg: IUnitCombinationArg) => {
return timeInMilliseconds;
};
export const getMilliSecondsAsHumanReadableString = (milliSecondsArg: number): string => {
return plugins.prettyMs(milliSecondsArg);
}