Skip to main content
Version: 9.14.0

Class: DateLib

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

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:140

Creates an instance of DateLib.

Parameters​

Returns​

DateLib

Methods​

addDays()​

addDays(date, amount): Date

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

Adds the specified number of days to the given date.

Parameters​

Returns​

Date

The new date with the days added.

addMonths()​

addMonths(date, amount): Date

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

Adds the specified number of months to the given date.

Parameters​

Returns​

Date

The new date with the months added.

addWeeks()​

addWeeks(date, amount): Date

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

Adds the specified number of weeks to the given date.

Parameters​

Returns​

Date

The new date with the weeks added.

addYears()​

addYears(date, amount): Date

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

Adds the specified number of years to the given date.

Parameters​

Returns​

Date

The new date with the years added.

differenceInCalendarDays()​

differenceInCalendarDays(dateLeft, dateRight): number

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

Returns the number of calendar days between the given dates.

Parameters​

Returns​

number

The number of calendar days between the dates.

differenceInCalendarMonths()​

differenceInCalendarMonths(dateLeft, dateRight): number

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

Returns the number of calendar months between the given dates.

Parameters​

Returns​

number

The number of calendar months between the dates.

eachMonthOfInterval()​

eachMonthOfInterval(interval): Date[]

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

Returns the months between the given dates.

Parameters​

Returns​

Date[]

eachYearOfInterval()​

eachYearOfInterval(interval): Date[]

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

Returns the years between the given dates.

Parameters​

Returns​

Date[]

The array of years in the interval.

Since​

9.11.1

endOfBroadcastWeek()​

endOfBroadcastWeek(date): Date

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

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

Parameters​

Returns​

Date

The end of the broadcast week.

endOfISOWeek()​

endOfISOWeek(date): Date

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

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

Parameters​

Returns​

Date

The end of the ISO week.

endOfMonth()​

endOfMonth(date): Date

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

Returns the end of the month for the given date.

Parameters​

Returns​

Date

The end of the month.

endOfWeek()​

endOfWeek(date, options?): Date

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

Returns the end of the week for the given date.

Parameters​

Returns​

Date

The end of the week.

endOfYear()​

endOfYear(date): Date

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

Returns the end of the year for the given date.

Parameters​

Returns​

Date

The end of the year.

format()​

format(date, formatStr, _options?): string

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

Formats the given date using the specified format string.

Parameters​

Returns​

string

The formatted date string.

formatMonthYear()​

formatMonthYear(date): string

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

Formats the month/year pair respecting locale conventions.

Parameters​

Returns​

string

Since​

9.11.0

formatNumber()​

formatNumber(value): string

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

Formats a number using the configured numbering system.

Parameters​

Returns​

string

The formatted number as a string.

Since​

9.5.0

getISOWeek()​

getISOWeek(date): number

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

Returns the ISO week number for the given date.

Parameters​

Returns​

number

The ISO week number.

getMonth()​

getMonth(date, _options?): number

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

Returns the month of the given date.

Parameters​

Returns​

number

The month.

getMonthYearOrder()​

getMonthYearOrder(): MonthYearOrder

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

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:535

Returns the local week number for the given date.

Parameters​

Returns​

number

The week number.

getYear()​

getYear(date, _options?): number

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

Returns the year of the given date.

Parameters​

Returns​

number

The year.

isAfter()​

isAfter(date, dateToCompare): boolean

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

Checks if the first date is after the second date.

Parameters​

Returns​

boolean

True if the first date is after the second date.

isBefore()​

isBefore(date, dateToCompare): boolean

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

Checks if the first date is before the second date.

Parameters​

Returns​

boolean

True if the first date is before the second date.

isSameDay()​

isSameDay(dateLeft, dateRight): boolean

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

Checks if the given dates are on the same day.

Parameters​

Returns​

boolean

True if the dates are on the same day.

isSameMonth()​

isSameMonth(dateLeft, dateRight): boolean

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

Checks if the given dates are in the same month.

Parameters​

Returns​

boolean

True if the dates are in the same month.

isSameYear()​

isSameYear(dateLeft, dateRight): boolean

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

Checks if the given dates are in the same year.

Parameters​

Returns​

boolean

True if the dates are in the same year.

max()​

max(dates): Date

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

Returns the latest date in the given array of dates.

Parameters​

Returns​

Date

The latest date.

min()​

min(dates): Date

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

Returns the earliest date in the given array of dates.

Parameters​

Returns​

Date

The earliest date.

newDate()​

newDate(year, monthIndex, date): Date

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

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

Parameters​

Returns​

Date

A new Date object.

Since​

9.5.0

setMonth()​

setMonth(date, month): Date

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

Sets the month of the given date.

Parameters​

Returns​

Date

The new date with the month set.

setYear()​

setYear(date, year): Date

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

Sets the year of the given date.

Parameters​

Returns​

Date

The new date with the year set.

startOfBroadcastWeek()​

startOfBroadcastWeek(date, _dateLib): Date

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

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

Parameters​

Returns​

Date

The start of the broadcast week.

startOfDay()​

startOfDay(date): Date

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

Returns the start of the day for the given date.

Parameters​

Returns​

Date

The start of the day.

startOfISOWeek()​

startOfISOWeek(date): Date

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

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

Parameters​

Returns​

Date

The start of the ISO week.

startOfMonth()​

startOfMonth(date): Date

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

Returns the start of the month for the given date.

Parameters​

Returns​

Date

The start of the month.

startOfWeek()​

startOfWeek(date, _options?): Date

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

Returns the start of the week for the given date.

Parameters​

Returns​

Date

The start of the week.

startOfYear()​

startOfYear(date): Date

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

Returns the start of the year for the given date.

Parameters​

Returns​

Date

The start of the year.

today()​

today(): Date

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

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:260

Reference to the built-in Date constructor.

Deprecated​

Use newDate() or today().

isDate()​

isDate: (value) => value is Date

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

Checks if the given value is a Date object.

Parameters​

Returns​

value is Date

True if the value is a Date object.

options​

readonly options: DateLibOptions

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

The options for configuring the date library.

overrides?​

readonly optional overrides: Partial<DateLib>

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

Overrides for the default date library functions.