Skip to content
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- `getQuarter` utility function
- `addQuarters` utility function

## [2.3.0] - 2026-04-07

### Added
Expand Down
31 changes: 31 additions & 0 deletions src/lib/date.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import {
getEndOfDay,
getFirstDayOfYear,
getLastDayOfYear,
addQuarters,
getQuarter,
} from "./date";

describe("date tests", () => {
Expand Down Expand Up @@ -162,4 +164,33 @@ describe("date tests", () => {
expect(getLastDayOfYear(date).getTime()).toBe(new Date(2024, 11, 31, 0, 0, 0, 0).getTime());
}
});

test.each([
[null as unknown as Date, Number.NaN],
Comment thread
drebrez marked this conversation as resolved.
[undefined as unknown as Date, Number.NaN],
[42 as unknown as Date, Number.NaN],
["test" as unknown as Date, Number.NaN],
[new Date("invalid-date"), Number.NaN],
[new Date("2026-01-15"), 1],
[new Date("2026-04-10"), 2],
[new Date("2026-08-20"), 3],
[new Date("2026-11-05"), 4],
])("getQuarter", (date, expected) => {
expect(getQuarter(date)).toBe(expected);
});

test.each([
[null as unknown as Date, 1, new Date(Number.NaN)],
[undefined as unknown as Date, -1, new Date(Number.NaN)],
[42 as unknown as Date, 1, new Date(Number.NaN)],
["test" as unknown as Date, -1, new Date(Number.NaN)],
[new Date("invalid-date"), 1, new Date(Number.NaN)],
[new Date(Number.NaN), 1, new Date(Number.NaN)],
[new Date(2026, 4, 29), 1, new Date(2026, 7, 29)],
[new Date(2026, 4, 29), 4, new Date(2027, 4, 29)],
[new Date(2026, 8, 15), -1, new Date(2026, 5, 15)],
[new Date(2026, 8, 15), -4, new Date(2025, 8, 15)],
])("addQuarters", (date, amount, expected) => {
expect(addQuarters(date, amount).getTime()).toBe(expected.getTime());
});
});
21 changes: 21 additions & 0 deletions src/lib/date.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import {
startOfDay,
endOfDay,
lastDayOfYear,
getQuarter as getQuarterInternal,
addQuarters as addQuartersInternal,
} from "date-fns";

/**
Expand Down Expand Up @@ -112,3 +114,22 @@ export function getFirstDayOfYear(date: Date): Date {
export function getLastDayOfYear(date: Date): Date {
return dateIsValid(date) ? lastDayOfYear(date) : new Date(Number.NaN);
}

/**
* Get the year quarter for the given date
* @param date The date
* @returns The year quarter
*/
export function getQuarter(date: Date): number {
return dateIsValid(date) ? getQuarterInternal(date) : Number.NaN;
}

/**
* Shifts a date by a given number of quarters.
* @param date The date
* @param amount Number of quarters to shift by (negative values shift the date backwards)
* @returns A new Date shifted by the specified number of quarters
*/
export function addQuarters(date: Date, amount: number): Date {
return dateIsValid(date) ? addQuartersInternal(date, amount) : new Date(Number.NaN);
}
Loading