UNPKG

1.55 kBTypeScriptView Raw
1/**
2 * Converts arbitrary values into Date values using extended conversion rules:
3 * - Strings: converted using ISO time format
4 * - Numbers: converted using milliseconds since unix epoch
5 *
6 * ### Example ###
7 *
8 * let value1 = DateTimeConverter.toNullableDateTime("ABC"); // Result: null
9 * let value2 = DateTimeConverter.toNullableDateTime("2018-01-01T11:30:00.0"); // Result: Date(2018,0,1,11,30)
10 * let value3 = DateTimeConverter.toNullableDateTime(123); // Result: Date(123)
11 */
12export declare class DateTimeConverter {
13 /**
14 * Converts value into Date or returns null when conversion is not possible.
15 *
16 * @param value the value to convert.
17 * @returns Date value or null when conversion is not supported.
18 */
19 static toNullableDateTime(value: any): Date;
20 /**
21 * Converts value into Date or returns current date when conversion is not possible.
22 *
23 * @param value the value to convert.
24 * @returns Date value or current date when conversion is not supported.
25 *
26 * @see [[toDateTimeWithDefault]]
27 */
28 static toDateTime(value: any): Date;
29 /**
30 * Converts value into Date or returns default when conversion is not possible.
31 *
32 * @param value the value to convert.
33 * @param defaultValue the default value.
34 * @returns Date value or default when conversion is not supported.
35 *
36 * @see [[toNullableDateTime]]
37 */
38 static toDateTimeWithDefault(value: any, defaultValue?: Date): Date;
39}