Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add luxon date adapter #52

Merged
merged 4 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"husky": "^8.0.0",
"jest": "^28.1.3",
"lint-staged": "^13.0.3",
"luxon": "^3.5.0",
"moment": "^2.29.4",
"prettier": "^2.7.1",
"timezone-mock": "^1.3.4",
Expand Down
9 changes: 9 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

177 changes: 177 additions & 0 deletions src/date-adapters/luxon/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
import { DateTime } from 'luxon';
import { DateAdapter } from '../date-adapter';

export function adapterFactory(luxon): DateAdapter {
/* istanbul ignore next */
function coerceDateTime(date: Date | number): DateTime {
return typeof date === 'number'
? luxon.DateTime.fromMillis(date)
: luxon.DateTime.fromJSDate(date);
}

function addDays(date: Date | number, amount: number): Date {
return coerceDateTime(date).plus({ days: amount }).toJSDate();
}

function addHours(date: Date | number, amount: number): Date {
return coerceDateTime(date).plus({ hours: amount }).toJSDate();
}

function addMinutes(date: Date | number, amount: number): Date {
return coerceDateTime(date).plus({ minutes: amount }).toJSDate();
}

function addSeconds(date: Date | number, amount: number): Date {
return coerceDateTime(date).plus({ seconds: amount }).toJSDate();
}

function differenceInDays(
dateLeft: Date | number,
dateRight: Date | number
): number {
return Math.trunc(
mattlewis92 marked this conversation as resolved.
Show resolved Hide resolved
coerceDateTime(dateLeft).diff(coerceDateTime(dateRight)).as('days')
);
}

function differenceInMinutes(
dateLeft: Date | number,
dateRight: Date | number
): number {
return Math.trunc(
coerceDateTime(dateLeft).diff(coerceDateTime(dateRight)).as('minutes')
);
}

function differenceInSeconds(
dateLeft: Date | number,
dateRight: Date | number
): number {
return Math.trunc(
coerceDateTime(dateLeft).diff(coerceDateTime(dateRight)).as('seconds')
);
}

function endOfDay(date: Date | number): Date {
return coerceDateTime(date).endOf('day').toJSDate();
}

function endOfMonth(date: Date | number): Date {
return coerceDateTime(date).endOf('month').toJSDate();
}

function endOfWeek(date: Date | number): Date {
return coerceDateTime(date)
.endOf('week', { useLocaleWeeks: true })
.toJSDate();
}

function getDay(date: Date | number): number {
// Luxon uses ISO 8601 weekday numbers, with 1 as Monday and 7 as Sunday
// https://moment.github.io/luxon/api-docs/index.html#datetimeweekday
return coerceDateTime(date).weekday % 7;
mattlewis92 marked this conversation as resolved.
Show resolved Hide resolved
}

/* istanbul ignore next */
function getMonth(date: Date | number): number {
// Luxon uses 1-based indexing for months
// https://moment.github.io/luxon/api-docs/index.html#datetimemonth
return coerceDateTime(date).month - 1;
}

function isSameDay(
dateLeft: Date | number,
dateRight: Date | number
): boolean {
return coerceDateTime(dateLeft).hasSame(coerceDateTime(dateRight), 'day');
}

function isSameMonth(
dateLeft: Date | number,
dateRight: Date | number
): boolean {
return coerceDateTime(dateLeft).hasSame(coerceDateTime(dateRight), 'month');
}

function isSameSecond(
dateLeft: Date | number,
dateRight: Date | number
): boolean {
return coerceDateTime(dateLeft).hasSame(
coerceDateTime(dateRight),
'second'
);
}

function max(dates: (Date | number)[]): Date {
return luxon.DateTime.max(
...dates.map((date) => coerceDateTime(date))
).toJSDate();
}

function setHours(date: Date | number, hours: number): Date {
return coerceDateTime(date).set({ hour: hours }).toJSDate();
}

function setMinutes(date: Date | number, minutes: number): Date {
return coerceDateTime(date).set({ minute: minutes }).toJSDate();
}

function startOfDay(date: Date | number): Date {
return coerceDateTime(date).startOf('day').toJSDate();
}

function startOfMinute(date: Date | number): Date {
return coerceDateTime(date).startOf('minute').toJSDate();
}

function startOfMonth(date: Date | number): Date {
return coerceDateTime(date).startOf('month').toJSDate();
}

function startOfWeek(date: Date | number): Date {
return coerceDateTime(date)
.startOf('week', { useLocaleWeeks: true })
.toJSDate();
}

function getHours(date: Date | number): number {
return coerceDateTime(date).hour;
}

function getMinutes(date: Date | number): number {
return coerceDateTime(date).minute;
}

function getTimezoneOffset(date: Date | number): number {
return coerceDateTime(date).offset * -1;
}

return {
addDays,
addHours,
addMinutes,
addSeconds,
differenceInDays,
differenceInMinutes,
differenceInSeconds,
endOfDay,
endOfMonth,
endOfWeek,
getDay,
getMonth,
isSameDay,
isSameMonth,
isSameSecond,
max,
setHours,
setMinutes,
startOfDay,
startOfMinute,
startOfMonth,
startOfWeek,
getHours,
getMinutes,
getTimezoneOffset,
};
}
5 changes: 5 additions & 0 deletions src/date-adapters/luxon/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"main": "./index.js",
"module": "../esm/luxon/index.js",
"typings": "./index.d.ts"
}
Loading
Loading