Class CalendarDate

CalendarDate represents a date without time or timezone information.

Index

Constructors

constructor

new CalendarDate(source?: CalendarDateObject | DateTime | null): CalendarDate
Internal
Parameters
- Optionalsource: CalendarDateObject | DateTime | null
Returns CalendarDate
- Defined in src/utils/datetime/CalendarDate.ts:26

Properties

`Protected` `Readonly`dateTime

dateTime: DateTime

Accessors

day

get day(): number
Gets the day of the month.

Returns number
The day number (1-31)
Example
```
CalendarDate.fromISO('2026-02-07').day  // 7
```
- Defined in src/utils/datetime/CalendarDate.ts:330

month

get month(): number
Gets the month (1-12).

Returns number
The month number (1 = January, 12 = December)
Example
```
CalendarDate.fromISO('2026-02-07').month  // 2
```
- Defined in src/utils/datetime/CalendarDate.ts:318

weekdayName

get weekdayName(): WeekdayName
Returns the lowercase name of the weekday.

Returns WeekdayName
Weekday name: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', or 'sunday'
Example
```
CalendarDate.fromISO('2026-02-09').weekdayName  // 'monday' (Feb 9, 2026 is a Monday)
CalendarDate.fromISO('2026-02-07').weekdayName  // 'saturday'
```
- Defined in src/utils/datetime/CalendarDate.ts:343

year

get year(): number
Gets the year.

Returns number
The year number
Example
```
CalendarDate.fromISO('2026-02-07').year  // 2026
```
- Defined in src/utils/datetime/CalendarDate.ts:306

Methods

diff

diff(
 other: CalendarDate,
 unit?: U,
): CalendarDateDiffResult
Returns the difference between this CalendarDate and another in the specified unit(s).
Type Parameters
- U extends CalendarDateDurationUnit | CalendarDateDurationUnit[] | undefined = undefined
Parameters
- other: CalendarDate
 CalendarDate to compare against
- Optionalunit: U
 Unit or units to return (years, quarters, months, weeks, days)
Returns CalendarDateDiffResult
Object with only the specified units (or all units if not specified)
Example
```
const d1 = CalendarDate.fromISO('2026-02-15')
const d2 = CalendarDate.fromISO('2026-02-07')
d1.diff(d2, 'days') // { days: 8 }
d1.diff(d2, ['months', 'days']) // { months: 0, days: 8 }
d1.diff(d2) // { years: 0, months: 0, days: 8 }
```
- Defined in src/utils/datetime/CalendarDate.ts:497

diffNow

diffNow(
 unit?: U,
): CalendarDateDiffResult
Returns the difference between this CalendarDate and today in the specified unit(s).
Type Parameters
- U extends CalendarDateDurationUnit | CalendarDateDurationUnit[] | undefined = undefined
Parameters
- Optionalunit: U
 Unit or units to return (years, quarters, months, weeks, days)
Returns CalendarDateDiffResult
Object with only the specified units (or all units if not specified)
Example
```
const future = CalendarDate.today().plus({ days: 5 })
future.diffNow('days') // { days: 5 }
future.diffNow(['months', 'days']) // { months: 0, days: 5 }
```
- Defined in src/utils/datetime/CalendarDate.ts:528

endOf

endOf(period: CalendarDateUnit): CalendarDate
Returns a new CalendarDate at the end of the given period.
Parameters
- period: CalendarDateUnit
  Unit to extend to end of ('year', 'quarter', 'month', 'week', or 'day')
Returns CalendarDate
A CalendarDate at the end of the period
Example
```
CalendarDate.fromISO('2026-02-15').endOf('month')  // 2026-02-28
CalendarDate.fromISO('2026-02-15').endOf('year')   // 2026-12-31
```
- Defined in src/utils/datetime/CalendarDate.ts:371

equals

equals(otherCalendarDate: CalendarDate): boolean
Returns true if this CalendarDate equals another CalendarDate.
Parameters
- otherCalendarDate: CalendarDate
  CalendarDate to compare
Returns boolean
true if dates are equal
Example
```
const d1 = CalendarDate.fromISO('2026-02-07')
const d2 = CalendarDate.fromISO('2026-02-07')
d1.equals(d2)  // true
```
- Defined in src/utils/datetime/CalendarDate.ts:545

hasSame

hasSame(otherCalendarDate: CalendarDate, period: CalendarDateUnit): boolean
Returns true if this and other are in the same unit of time.
Parameters
- otherCalendarDate: CalendarDate
  CalendarDate to compare against
- period: CalendarDateUnit
  Unit to check ('year', 'quarter', 'month', 'week', or 'day')
Returns boolean
true if same period
Example
```
const d1 = CalendarDate.fromISO('2026-02-07')
const d2 = CalendarDate.fromISO('2026-02-15')
d1.hasSame(d2, 'month')  // true
d1.hasSame(d2, 'day')    // false
```
- Defined in src/utils/datetime/CalendarDate.ts:464

minus

minus(duration: CalendarDateDurationLike): CalendarDate
Returns a new CalendarDate with the given duration subtracted.
Parameters
- duration: CalendarDateDurationLike
  Duration to subtract (object with years, months, weeks, days, etc.)
Returns CalendarDate
A new CalendarDate
Example
```
CalendarDate.fromISO('2026-02-07').minus({ days: 5 })    // 2026-02-02
CalendarDate.fromISO('2026-02-07').minus({ months: 2 })  // 2025-12-07
```
- Defined in src/utils/datetime/CalendarDate.ts:399

plus

plus(duration: CalendarDateDurationLike): CalendarDate
Returns a new CalendarDate with the given duration added.
Parameters
- duration: CalendarDateDurationLike
  Duration to add (object with years, months, weeks, days, etc.)
Returns CalendarDate
A new CalendarDate
Example
```
CalendarDate.fromISO('2026-02-07').plus({ days: 5 })    // 2026-02-12
CalendarDate.fromISO('2026-02-07').plus({ months: 2 })  // 2026-04-07
```
- Defined in src/utils/datetime/CalendarDate.ts:385

set

set(values: Partial<CalendarDateObject>): CalendarDate
Returns a new CalendarDate with the given date units set.
Parameters
- values: Partial<CalendarDateObject>
 Object with date units to set (year, month, day)
Returns CalendarDate
A new CalendarDate
Throws
When the underlying DateTime operation fails
Example
```
CalendarDate.fromISO('2026-02-07').set({ year: 2025, day: 15 }) // 2025-02-15
```
- Defined in src/utils/datetime/CalendarDate.ts:413

startOf

startOf(period: CalendarDateUnit): CalendarDate
Returns a new CalendarDate at the start of the given period.
Parameters
- period: CalendarDateUnit
  Unit to truncate to ('year', 'quarter', 'month', 'week', or 'day')
Returns CalendarDate
A CalendarDate at the start of the period
Example
```
CalendarDate.fromISO('2026-02-15').startOf('month')  // 2026-02-01
CalendarDate.fromISO('2026-02-15').startOf('year')   // 2026-01-01
```
- Defined in src/utils/datetime/CalendarDate.ts:357

toDateTime

toDateTime(): DateTime
Returns the underlying DateTime instance (at midnight UTC).

Returns DateTime
A DateTime representing this date at 00:00:00 UTC
Example
```
const dt = CalendarDate.today().toDateTime()
```
- Defined in src/utils/datetime/CalendarDate.ts:282

toISO

toISO(): string
Returns the date as an ISO 8601 string.

Returns string
ISO date string (e.g., '2026-02-07')
Example
```
CalendarDate.fromObject({ year: 2026, month: 2, day: 7 }).toISO()  // '2026-02-07'
```
- Defined in src/utils/datetime/CalendarDate.ts:187

toISODate

toISODate(): string
Returns the date as an ISO date string. Alias for toISO().

Returns string
ISO date string (e.g., '2026-02-07')
Example
```
CalendarDate.fromObject({ year: 2026, month: 2, day: 7 }).toISODate()  // '2026-02-07'
```
- Defined in src/utils/datetime/CalendarDate.ts:201

toJSDate

toJSDate(): Date
Returns a JavaScript Date for this date (at midnight UTC).

Returns Date
A JavaScript Date instance
Example
```
const jsDate = CalendarDate.today().toJSDate()
```
- Defined in src/utils/datetime/CalendarDate.ts:294

toJSON

toJSON(): string
Returns the date as an ISO string for JSON serialization.

Returns string
ISO date string (e.g., '2026-02-07')
Example
```
JSON.stringify({ date: CalendarDate.today() })
```
- Defined in src/utils/datetime/CalendarDate.ts:228

toLocaleString

toLocaleString(formatOpts?: DateTimeFormatOptions, opts?: LocaleOptions): string
Returns a localized string representation of the date.
Parameters
- OptionalformatOpts: DateTimeFormatOptions
  Intl.DateTimeFormat options for formatting
- Optionalopts: LocaleOptions
  Optional locale options
Returns string
Localized date string
Example
```
CalendarDate.today().toLocaleString()
CalendarDate.today().toLocaleString({ month: 'long', day: 'numeric', year: 'numeric' })
```
- Defined in src/utils/datetime/CalendarDate.ts:258

toSQL

toSQL(): string
Returns string
- Defined in src/utils/datetime/CalendarDate.ts:214

toString

toString(): string
Returns the date as an ISO string (same as toISO).

Returns string
ISO date string (e.g., '2026-02-07')
Example
```
String(CalendarDate.today())
```
- Defined in src/utils/datetime/CalendarDate.ts:270

valueOf

valueOf(): string
Returns string
- Defined in src/utils/datetime/CalendarDate.ts:241

`Static`fromDateTime

fromDateTime(dateTime: DateTime): CalendarDate
Create a CalendarDate from a DateTime instance.
Parameters
- dateTime: DateTime
  A DateTime instance
Returns CalendarDate
A CalendarDate for the date portion of the DateTime
Example
```
CalendarDate.fromDateTime(DateTime.now())
```
- Defined in src/utils/datetime/CalendarDate.ts:51

`Static`fromFormat

fromFormat(text: string, format: string, opts?: DateTimeOptions): CalendarDate
Create a CalendarDate from a custom format string. Uses Luxon format tokens (e.g., 'MM/dd/yyyy', 'MMMM dd, yyyy').
Parameters
- text: string
  The string to parse
- format: string
  Format string using Luxon tokens
- Optionalopts: DateTimeOptions
Returns CalendarDate
A CalendarDate for the parsed date
Throws
When the string doesn't match the format or is invalid
Example
```
CalendarDate.fromFormat('12/15/2017', 'MM/dd/yyyy')
CalendarDate.fromFormat('May 25, 1982', 'MMMM dd, yyyy')
CalendarDate.fromFormat('mai 25, 1982', 'MMMM dd, yyyy', { locale: 'fr' })
```
- Defined in src/utils/datetime/CalendarDate.ts:116

`Static`fromISO

fromISO(str: string, opts?: { zone?: string | Zone }): CalendarDate
Create a CalendarDate from an ISO 8601 date string.
Parameters
- str: string
  ISO date string (e.g., '2026-02-07')
- opts: { zone?: string | Zone } = {}
Returns CalendarDate
A CalendarDate for the given date
Throws
When the ISO string is invalid
Example
```
CalendarDate.fromISO('2026-02-07')
```
- Defined in src/utils/datetime/CalendarDate.ts:81

`Static`fromJSDate

fromJSDate(javascriptDate: Date, opts?: { zone?: string | Zone }): CalendarDate
Create a CalendarDate from a JavaScript Date.
Parameters
- javascriptDate: Date
  A JavaScript Date instance
- opts: { zone?: string | Zone } = {}
Returns CalendarDate
A CalendarDate for the date portion
Example
```
CalendarDate.fromJSDate(new Date())
CalendarDate.fromJSDate(new Date(), { zone: 'America/New_York' })
```
- Defined in src/utils/datetime/CalendarDate.ts:66

`Static`fromObject

fromObject(obj: CalendarDateObject, opts?: DateTimeJSOptions): CalendarDate
Create a CalendarDate from an object with date units.
Parameters
- obj: CalendarDateObject
  Object with year, month, day properties
- Optionalopts: DateTimeJSOptions
  Optional zone/locale options
Returns CalendarDate
A CalendarDate for the given components
Throws
When date values are invalid
Example
```
CalendarDate.fromObject({ year: 2026, month: 2, day: 7 })
```
- Defined in src/utils/datetime/CalendarDate.ts:132

`Static`fromSQL

fromSQL(str: string): CalendarDate
Create a CalendarDate from an SQL date string.
Parameters
- str: string
  SQL date string (e.g., '2026-02-07')
Returns CalendarDate
A CalendarDate for the given date
Throws
When the SQL string is invalid
Example
```
CalendarDate.fromSQL('2026-02-07')
```
- Defined in src/utils/datetime/CalendarDate.ts:96

`Static`max

max(...calendarDates: CalendarDate[]): CalendarDate | null
Returns the latest CalendarDate from the given arguments.
Parameters
- ...calendarDates: CalendarDate[]
  CalendarDates to compare
Returns CalendarDate | null
The latest CalendarDate
Example
```
CalendarDate.max(date1, date2, date3)
```
- Defined in src/utils/datetime/CalendarDate.ts:443

`Static`min

min(...calendarDates: CalendarDate[]): CalendarDate | null
Returns the earliest CalendarDate from the given arguments.
Parameters
- ...calendarDates: CalendarDate[]
  CalendarDates to compare
Returns CalendarDate | null
The earliest CalendarDate
Example
```
CalendarDate.min(date1, date2, date3)
```
- Defined in src/utils/datetime/CalendarDate.ts:426

`Static`today

today(opts?: { zone?: string | Zone }): CalendarDate
Returns a CalendarDate for today's date.
Parameters
- Optionalopts: { zone?: string | Zone }
Returns CalendarDate
A CalendarDate for today
Example
```
CalendarDate.today()
CalendarDate.today({ zone: 'America/New_York' })
```
- Defined in src/utils/datetime/CalendarDate.ts:147

`Static`tomorrow

tomorrow(options?: { zone?: string | Zone }): CalendarDate
Returns a CalendarDate for tomorrow's date.
Parameters
- options: { zone?: string | Zone } = {}
  Optional zone (defaults to UTC)
Returns CalendarDate
A CalendarDate for tomorrow
Example
```
CalendarDate.tomorrow()
CalendarDate.tomorrow({ zone: 'America/New_York' })
```
- Defined in src/utils/datetime/CalendarDate.ts:161

`Static`yesterday

yesterday(options?: { zone?: string | Zone }): CalendarDate
Returns a CalendarDate for yesterday's date.
Parameters
- options: { zone?: string | Zone } = {}
  Optional zone (defaults to UTC)
Returns CalendarDate
A CalendarDate for yesterday
Example
```
CalendarDate.yesterday()
CalendarDate.yesterday({ zone: 'America/New_York' })
```
- Defined in src/utils/datetime/CalendarDate.ts:175

Class CalendarDate

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CalendarDate

Properties

Protected ReadonlydateTime

Accessors

day

Returns number

Example

month

Returns number

Example

weekdayName

Returns WeekdayName

Example

year

Returns number

Example

Methods

diff

Type Parameters

Parameters

Returns CalendarDateDiffResult<U>

Example

diffNow

Type Parameters

Parameters

Returns CalendarDateDiffResult<U>

Example

endOf

Parameters

Returns CalendarDate

Example

equals

Parameters

Returns boolean

Example

hasSame

Parameters

Returns boolean

Example

minus

Parameters

Returns CalendarDate

Example

plus

Parameters

Returns CalendarDate

Example

set

Parameters

Returns CalendarDate

Throws

Example

startOf

Parameters

Returns CalendarDate

Example

toDateTime

Returns DateTime

Example

toISO

Returns string

Example

toISODate

Returns string

Example

toJSDate

Returns Date

Example

toJSON

Returns string

Example

`Protected` `Readonly`dateTime

`Static`fromDateTime

`Static`fromFormat

`Static`fromISO

`Static`fromJSDate

`Static`fromObject

`Static`fromSQL

`Static`max

`Static`min

`Static`today

`Static`tomorrow

`Static`yesterday