Skip to content

Commit

Permalink
Merge pull request #443 from Akim95/typings
Browse files Browse the repository at this point in the history
[starter] added ts definitions
  • Loading branch information
ncb000gt authored Oct 4, 2019
2 parents e6734d2 + 985773e commit ced241b
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 0 deletions.
94 changes: 94 additions & 0 deletions lib/cron.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// TypeScript Version: 3.5.2

interface CronJobOptions {
cronTime: string | Date | CronTime;
onTick: () => void;
onComplete?: () => void;
context?: any;
startNow?: boolean;
timeZone?: string;
runOnInit?: boolean;
utcOffset?: number;
unrefTimeout?: any;
}

interface CronTimeOptions {
time: string | Date;
zone?: string;
utcOffset?: number;
}

export declare function job<T>(
cronTime: string | Date | CronTime,
onTick: () => void,
onComplete?: () => void,
context?: any,
startNow?: boolean,
timeZone?: string,
runOnInit?: boolean,
utcOffset?: number,
unrefTimeout?: any): T;
export declare function time<T>(cronTime: string | Date, timeZone: string): T;
export declare function sendAt<T>(cronTime: string | Date): T;
export declare function timeout<T>(cronTime: string | Date): T;

declare class CronTime {
constructor(time: string | Date, zone?: string, utcOffset?: number);

_verifyParse(): void;

sendAt<T>(i: number): T;

getTimeout(): void;

toString(): void;

toJSON(): void;

_getNextDateFrom(start: string | Date, zone: string): void;

_findDST(date: string | Date): void;

_wcOrAll(type: number): void;

_hasAll(type: number): void;

_parse(): void;

_parseField(field: string, type: number, constraints: number[]): void;


}

declare class CronJob {
constructor(
cronTime: string | Date | CronTime,
onTick: () => void,
onComplete?: () => void,
context?: any,
startNow?: boolean,
timeZone?: string,
runOnInit?: boolean,
utcOffset?: number,
unrefTimeout?: any,
);

constructor(CronJobOptions: CronJobOptions);

addCallback(): void;

setTime(time: string | CronTime): void;

nextDate(): void;

fireOnTick(): void;

start(): void;

lastDate(): void;

stop(): void;

}

export { CronJob, CronTime };
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"url": "http://github.com/kelektiv/node-cron.git"
},
"main": "lib/cron",
"types": "lib/cron.d.ts",
"scripts": {
"test": "make test"
},
Expand Down

0 comments on commit ced241b

Please sign in to comment.