Class: DateLib

Defined in: src/classes/DateLib.ts:120

A wrapper class around date-fns that provides utility methods for date manipulation and formatting.

Since

9.2.0

Example

const dateLib = new DateLib({ locale: es });
  const newDate = dateLib.addDays(new Date(), 5);

Constructors

Constructor

new DateLib(options?, overrides?): DateLib

Defined in: src/classes/DateLib.ts:133

Creates an instance of DateLib.

Parameters

Parameter	Type	Description
options?	DateLibOptions	Configuration options for the date library.
overrides?	Partial<DateLib>	Custom overrides for the date library functions.

Returns

DateLib

Methods

addDays()

addDays(date, amount): Date

Defined in: src/classes/DateLib.ts:297

Adds the specified number of days to the given date.

Parameters

Parameter	Type	Description
date	Date	The date to add days to.
amount	number	The number of days to add.

Returns

Date

The new date with the days added.

---

addMonths()

addMonths(date, amount): Date

Defined in: src/classes/DateLib.ts:310

Adds the specified number of months to the given date.

Parameters

Parameter	Type	Description
date	Date	The date to add months to.
amount	number	The number of months to add.

Returns

Date

The new date with the months added.

---

addWeeks()

addWeeks(date, amount): Date

Defined in: src/classes/DateLib.ts:323

Adds the specified number of weeks to the given date.

Parameters

Parameter	Type	Description
date	Date	The date to add weeks to.
amount	number	The number of weeks to add.

Returns

Date

The new date with the weeks added.

---

addYears()

addYears(date, amount): Date

Defined in: src/classes/DateLib.ts:336

Adds the specified number of years to the given date.

Parameters

Parameter	Type	Description
date	Date	The date to add years to.
amount	number	The number of years to add.

Returns

Date

The new date with the years added.

---

differenceInCalendarDays()

differenceInCalendarDays(dateLeft, dateRight): number

Defined in: src/classes/DateLib.ts:349

Returns the number of calendar days between the given dates.

Parameters

Parameter	Type	Description
dateLeft	Date	The later date.
dateRight	Date	The earlier date.

Returns

number

The number of calendar days between the dates.

---

differenceInCalendarMonths()

differenceInCalendarMonths(dateLeft, dateRight): number

Defined in: src/classes/DateLib.ts:362

Returns the number of calendar months between the given dates.

Parameters

Parameter	Type	Description
dateLeft	Date	The later date.
dateRight	Date	The earlier date.

Returns

number

The number of calendar months between the dates.

---

eachMonthOfInterval()

eachMonthOfInterval(interval): Date[]

Defined in: src/classes/DateLib.ts:373

Returns the months between the given dates.

Parameters

Parameter	Type	Description
interval	Interval	The interval to get the months for.

Returns

Date[]

---

eachYearOfInterval()

eachYearOfInterval(interval): Date[]

Defined in: src/classes/DateLib.ts:386

Returns the years between the given dates.

Parameters

Parameter	Type	Description
interval	Interval	The interval to get the years for.

Returns

Date[]

The array of years in the interval.

Since

9.11.1

---

endOfBroadcastWeek()

endOfBroadcastWeek(date): Date

Defined in: src/classes/DateLib.ts:411

Returns the end of the broadcast week for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The end of the broadcast week.

---

endOfISOWeek()

endOfISOWeek(date): Date

Defined in: src/classes/DateLib.ts:423

Returns the end of the ISO week for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The end of the ISO week.

---

endOfMonth()

endOfMonth(date): Date

Defined in: src/classes/DateLib.ts:435

Returns the end of the month for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The end of the month.

---

endOfWeek()

endOfWeek(date, options?): Date

Defined in: src/classes/DateLib.ts:447

Returns the end of the week for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.
options?	EndOfWeekOptions<Date>	-

Returns

Date

The end of the week.

---

endOfYear()

endOfYear(date): Date

Defined in: src/classes/DateLib.ts:459

Returns the end of the year for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The end of the year.

---

format()

format(date, formatStr, _options?): string

Defined in: src/classes/DateLib.ts:472

Formats the given date using the specified format string.

Parameters

Parameter	Type	Description
date	Date	The date to format.
formatStr	string	The format string.
_options?	FormatOptions	-

Returns

string

The formatted date string.

---

formatMonthYear()

formatMonthYear(date): string

Defined in: src/classes/DateLib.ts:205

Formats the month/year pair respecting locale conventions.

Parameters

Parameter	Type
date	Date

Returns

string

Since

9.11.0

---

formatNumber()

formatNumber(value): string

Defined in: src/classes/DateLib.ts:184

Formats a number using the configured numbering system.

Parameters

Parameter	Type	Description
value	string | number	The number to format.

Returns

string

The formatted number as a string.

Since

9.5.0

---

getISOWeek()

getISOWeek(date): number

Defined in: src/classes/DateLib.ts:492

Returns the ISO week number for the given date.

Parameters

Parameter	Type	Description
date	Date	The date to get the ISO week number for.

Returns

number

The ISO week number.

---

getMonth()

getMonth(date, _options?): number

Defined in: src/classes/DateLib.ts:504

Returns the month of the given date.

Parameters

Parameter	Type	Description
date	Date	The date to get the month for.
_options?	GetMonthOptions	-

Returns

number

The month.

---

getMonthYearOrder()

getMonthYearOrder(): MonthYearOrder

Defined in: src/classes/DateLib.ts:192

Returns the preferred ordering for month and year labels for the current locale.

Returns

MonthYearOrder

---

getWeek()

getWeek(date, _options?): number

Defined in: src/classes/DateLib.ts:528

Returns the local week number for the given date.

Parameters

Parameter	Type	Description
date	Date	The date to get the week number for.
_options?	GetWeekOptions	-

Returns

number

The week number.

---

getYear()

getYear(date, _options?): number

Defined in: src/classes/DateLib.ts:516

Returns the year of the given date.

Parameters

Parameter	Type	Description
date	Date	The date to get the year for.
_options?	GetYearOptions	-

Returns

number

The year.

---

isAfter()

isAfter(date, dateToCompare): boolean

Defined in: src/classes/DateLib.ts:541

Checks if the first date is after the second date.

Parameters

Parameter	Type	Description
date	Date	The date to compare.
dateToCompare	Date	The date to compare with.

Returns

boolean

True if the first date is after the second date.

---

isBefore()

isBefore(date, dateToCompare): boolean

Defined in: src/classes/DateLib.ts:554

Checks if the first date is before the second date.

Parameters

Parameter	Type	Description
date	Date	The date to compare.
dateToCompare	Date	The date to compare with.

Returns

boolean

True if the first date is before the second date.

---

isSameDay()

isSameDay(dateLeft, dateRight): boolean

Defined in: src/classes/DateLib.ts:579

Checks if the given dates are on the same day.

Parameters

Parameter	Type	Description
dateLeft	Date	The first date to compare.
dateRight	Date	The second date to compare.

Returns

boolean

True if the dates are on the same day.

---

isSameMonth()

isSameMonth(dateLeft, dateRight): boolean

Defined in: src/classes/DateLib.ts:592

Checks if the given dates are in the same month.

Parameters

Parameter	Type	Description
dateLeft	Date	The first date to compare.
dateRight	Date	The second date to compare.

Returns

boolean

True if the dates are in the same month.

---

isSameYear()

isSameYear(dateLeft, dateRight): boolean

Defined in: src/classes/DateLib.ts:605

Checks if the given dates are in the same year.

Parameters

Parameter	Type	Description
dateLeft	Date	The first date to compare.
dateRight	Date	The second date to compare.

Returns

boolean

True if the dates are in the same year.

---

max()

max(dates): Date

Defined in: src/classes/DateLib.ts:617

Returns the latest date in the given array of dates.

Parameters

Parameter	Type	Description
dates	Date[]	The array of dates to compare.

Returns

Date

The latest date.

---

min()

min(dates): Date

Defined in: src/classes/DateLib.ts:627

Returns the earliest date in the given array of dates.

Parameters

Parameter	Type	Description
dates	Date[]	The array of dates to compare.

Returns

Date

The earliest date.

---

newDate()

newDate(year, monthIndex, date): Date

Defined in: src/classes/DateLib.ts:280

Creates a new Date object with the specified year, month, and day.

Parameters

Parameter	Type	Description
year	number	The year.
monthIndex	number	The month (0-11).
date	number	The day of the month.

Returns

Date

A new Date object.

Since

9.5.0

---

setMonth()

setMonth(date, month): Date

Defined in: src/classes/DateLib.ts:638

Sets the month of the given date.

Parameters

Parameter	Type	Description
date	Date	The date to set the month on.
month	number	The month to set (0-11).

Returns

Date

The new date with the month set.

---

setYear()

setYear(date, year): Date

Defined in: src/classes/DateLib.ts:651

Sets the year of the given date.

Parameters

Parameter	Type	Description
date	Date	The date to set the year on.
year	number	The year to set.

Returns

Date

The new date with the year set.

---

startOfBroadcastWeek()

startOfBroadcastWeek(date, _dateLib): Date

Defined in: src/classes/DateLib.ts:663

Returns the start of the broadcast week for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.
_dateLib	DateLib	-

Returns

Date

The start of the broadcast week.

---

startOfDay()

startOfDay(date): Date

Defined in: src/classes/DateLib.ts:675

Returns the start of the day for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The start of the day.

---

startOfISOWeek()

startOfISOWeek(date): Date

Defined in: src/classes/DateLib.ts:687

Returns the start of the ISO week for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The start of the ISO week.

---

startOfMonth()

startOfMonth(date): Date

Defined in: src/classes/DateLib.ts:699

Returns the start of the month for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The start of the month.

---

startOfWeek()

startOfWeek(date, _options?): Date

Defined in: src/classes/DateLib.ts:711

Returns the start of the week for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.
_options?	StartOfWeekOptions<Date>	-

Returns

Date

The start of the week.

---

startOfYear()

startOfYear(date): Date

Defined in: src/classes/DateLib.ts:723

Returns the start of the year for the given date.

Parameters

Parameter	Type	Description
date	Date	The original date.

Returns

Date

The start of the year.

---

today()

today(): Date

Defined in: src/classes/DateLib.ts:261

Creates a new Date object representing today's date.

Returns

Date

A Date object for today's date.

Since

9.5.0

Properties

Date

Date: DateConstructor

Defined in: src/classes/DateLib.ts:253

Reference to the built-in Date constructor.

Deprecated

Use newDate() or today().

---

isDate()

isDate: (value) => value is Date

Defined in: src/classes/DateLib.ts:566

Checks if the given value is a Date object.

Parameters

Parameter	Type	Description
value	unknown	The value to check.

Returns

value is Date

True if the value is a Date object.

---

options

readonly options: DateLibOptions

Defined in: src/classes/DateLib.ts:122

The options for configuring the date library.

---

overrides?

readonly optional overrides: Partial<DateLib>

Defined in: src/classes/DateLib.ts:125

Overrides for the default date library functions.