UNPKG

1.42 kBTypeScriptView Raw
1/**
2 * Random generator for Date time values.
3 *
4 * ### Example ###
5 *
6 * let value1 = RandomDateTime.nextDate(new Date(2010,0,1)); // Possible result: 2008-01-03
7 * let value2 = RandomDateTime.nextDateTime(new Date(2017,0.1));// Possible result: 2007-03-11 11:20:32
8 * let value3 = RandomDateTime.updateDateTime(new Date(2010,1,2));// Possible result: 2010-02-05 11:33:23
9 */
10export declare class RandomDateTime {
11 /**
12 * Generates a random Date in the range ['minYear', 'maxYear'].
13 * This method generate dates without time (or time set to 00:00:00)
14 *
15 * @param min (optional) minimum range value
16 * @param max max range value
17 * @returns a random Date value.
18 */
19 static nextDate(min: Date, max?: Date): Date;
20 /**
21 * Generates a random Date and time in the range ['minYear', 'maxYear'].
22 * This method generate dates without time (or time set to 00:00:00)
23 *
24 * @param min (optional) minimum range value
25 * @param max max range value
26 * @returns a random Date and time value.
27 */
28 static nextDateTime(min: Date, max?: Date): Date;
29 /**
30 * Updates (drifts) a Date value within specified range defined
31 *
32 * @param value a Date value to drift.
33 * @param range (optional) a range in milliseconds. Default: 10 days
34 */
35 static updateDateTime(value: Date, range?: number): Date;
36}