-
Notifications
You must be signed in to change notification settings - Fork 0
/
PlainDate.ts
199 lines (179 loc) · 5.34 KB
/
PlainDate.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
import { createUtcInstant } from "./utils/createUtcInstant.ts";
import { MonthNumber } from "./constants.ts";
import { RequireAtLeastOne } from "./support/utility-types.ts";
export type FormatPlainDateOptions = Omit<
Intl.DateTimeFormatOptions,
"timeZone" | "timeZoneName"
>;
/**
* Describes a basic plain-date object with minimal properties.
*
* @see {@link PlainDate} factory for creating objects
*/
export interface ComPlainDate {
/** Year may be negative and up to 6 digits */
year: number;
/** Month (1-12) */
month: MonthNumber;
/** Day in month (1-31) */
day: number;
/** `yyyy-mm-dd` (ISO 8601) */
iso: string;
/** `yyyy-mm-dd` (ISO 8601) */
valueOf: () => this["iso"];
/** `yyyy-mm-dd` (ISO 8601) */
toString: () => this["iso"];
/** `yyyy-mm-dd` (ISO 8601) */
toJSON: () => this["iso"];
/**
* Localize the date for display to a user.
*
* @param locale `Intl` {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument | locale }, defaults to system's locale if not given
* @param options `Intl` {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat | format options }, defaults to "short" date-style if not given
*
* @example
* ```ts
* // "6/12/2023"
* PlainDate({ year: 2023, month: 6, day: 12 }).toLocaleString('en');
*
* // "6/12"
* PlainDate({ year: 2023, month: 6, day: 12 }).toLocaleString('en', { month: 'numeric', day: 'numeric' });
*
* // "June 12"
* PlainDate({ year: 2023, month: 6, day: 12 }).toLocaleString('en', { month: 'long', day: 'numeric' });
* ```
*/
toLocaleString: (
locale?: Intl.LocalesArgument,
options?: FormatPlainDateOptions,
) => string;
/**
* Get a native JS `Date` object in UTC.
*/
toUtcInstant: (time?: {
hour?: number | string;
minute?: number | string;
second?: number | string;
millisecond?: number | string;
}) => Date;
/**
* Check for partial or complete equality.
*/
is: (
x: RequireAtLeastOne<{
year?: number | string;
month?: number | string;
day?: number | string;
}>,
) => boolean;
constructor: PlainDateFactory<this>;
/**
* Apply a pipeline of functions to this plain-date, from left to right.
*
* @param fns Functions that take a plain-date and return a plain-date
* @returns The output of the last function
*/
pipe: <T extends ComPlainDate>(
this: T,
...fns: Array<(date: T) => T>
) => T;
/**
* Create a new plain-date object from this one, modified by a function.
*
* @param f A function that takes a plain-date and returns a date object with properties `year`, `month` & `day`
* @returns A new plain-date made from the date
*/
map: <T extends ComPlainDate>(
this: T,
f: (x: T) => {
year: number | string;
month: number | string;
day: number | string;
},
) => T;
}
/**
* Describes a factory function that creates plain-date objects.
*
* Specific implementations of the factory may provide additional methods that
* takes other kinds of arguments.
*/
export interface PlainDateFactory<T extends ComPlainDate> {
(x: {
year: number | string;
month?: number | string;
day?: number | string;
}): T;
fromString?: <T extends ComPlainDate>(
this: PlainDateFactory<T>,
s: string,
) => T;
fromUtcInstant?: <T extends ComPlainDate>(
this: PlainDateFactory<T>,
instant?: Date,
) => T;
fromLocalInstant?: <T extends ComPlainDate>(
this: PlainDateFactory<T>,
instant?: Date,
) => T;
fromInstant?: <T extends ComPlainDate>(
this: PlainDateFactory<T>,
timezone: string,
instant?: Date,
) => T;
}
/**
* Factory function for making basic plain-date objects with minimal properties.
*
* @param date A date object with properties `year`, `month` & `day`
* @returns A new immutable plain-date object
*/
export function PlainDate({ year, month = 1, day = 1 }: {
year: number | string;
month?: number | string;
day?: number | string;
}): ComPlainDate {
const utcInstant = createUtcInstant({ year, month, day });
if (isNaN(utcInstant.valueOf())) {
throw new RangeError(
`Input is not a valid date: ${JSON.stringify({ year, month, day })}`,
);
}
const plainDate: ComPlainDate = {
constructor: PlainDate,
year: utcInstant.getUTCFullYear(),
month: utcInstant.getUTCMonth() + 1 as MonthNumber,
day: utcInstant.getUTCDate(),
iso: utcInstant.toISOString().split("T")[0],
valueOf() {
return this.iso;
},
toString() {
return this.iso;
},
toJSON() {
return this.iso;
},
toLocaleString(locale, options = { dateStyle: "short" }) {
return utcInstant.toLocaleDateString(locale, {
...options,
timeZone: "UTC",
});
},
toUtcInstant({ hour = 0, minute = 0, second = 0, millisecond = 0 } = {}) {
return createUtcInstant({ ...this, hour, minute, second, millisecond });
},
is({ year, month, day }) {
return (year === undefined || this.year == year) &&
(month === undefined || this.month == month) &&
(day === undefined || this.day == day);
},
pipe(...fns) {
return fns.reduce((x, f) => f(x), this);
},
map(f) {
return this.constructor(f(this));
},
};
return Object.freeze(plainDate);
}