• addDays
  • Parameters
  • Examples
• addHours
  • Parameters
  • Examples
• addMilliseconds
  • Parameters
  • Examples
• addMinutes
  • Parameters
  • Examples
• addMonths
  • Parameters
  • Examples
• addQuarters
  • Parameters
  • Examples
• addSeconds
  • Parameters
  • Examples
• addWeeks
  • Parameters
  • Examples
• addYears
  • Parameters
  • Examples
• differenceInDays
  • Parameters
  • Examples
• differenceInHours
  • Parameters
  • Examples
• differenceInMilliseconds
  • Parameters
  • Examples
• differenceInMinutes
  • Parameters
  • Examples
• differenceInMonths
  • Parameters
  • Examples
• differenceInQuarters
  • Parameters
  • Examples
• differenceInSeconds
  • Parameters
  • Examples
• differenceInWeeks
  • Parameters
  • Examples
• differenceInYears
  • Parameters
  • Examples
• getDayOfYear
  • Parameters
  • Examples
• getQuarterOfYear
  • Parameters
  • Examples
• getWeekOfYear
  • Parameters
  • Examples
• Interval
  • Properties
• isAfter
  • Parameters
  • Examples
• isBefore
  • Parameters
  • Examples
• isBetween
  • Parameters
  • Examples
• isCurrentDay
  • Parameters
  • Examples
• isCurrentHour
  • Parameters
  • Examples
• isCurrentMinute
  • Parameters
  • Examples
• isCurrentMonth
  • Parameters
  • Examples
• isCurrentQuarter
  • Parameters
  • Examples
• isCurrentSecond
  • Parameters
  • Examples
• isCurrentWeek
  • Parameters
  • Examples
• isCurrentWeekday
  • Parameters
  • Examples
• isCurrentYear
  • Parameters
  • Examples
• isDate
  • Parameters
• isEqual
  • Parameters
  • Examples
• isFriday
  • Parameters
  • Examples
• isFuture
  • Parameters
  • Examples
• isLeapYear
  • Parameters
  • Examples
• isMonday
  • Parameters
  • Examples
• isPast
  • Parameters
  • Examples
• isSameDay
  • Parameters
  • Examples
• isSameHour
  • Parameters
  • Examples
• isSameMinute
  • Parameters
  • Examples
• isSameMonth
  • Parameters
  • Examples
• isSameQuarter
  • Parameters
  • Examples
• isSameSecond
  • Parameters
  • Examples
• isSameWeek
  • Parameters
  • Examples
• isSameWeekday
  • Parameters
  • Examples
• isSameYear
  • Parameters
  • Examples
• isSaturday
  • Parameters
  • Examples
• isSunday
  • Parameters
  • Examples
• isThursday
  • Parameters
  • Examples
• isTomorrow
  • Parameters
  • Examples
• isTuesday
  • Parameters
  • Examples
• isWednesday
  • Parameters
  • Examples
• isYesterday
  • Parameters
  • Examples
• max
  • Parameters
  • Examples
• min
  • Parameters
  • Examples
• subtractDays
  • Parameters
  • Examples
• subtractHours
  • Parameters
  • Examples
• subtractMilliseconds
  • Parameters
  • Examples
• subtractMinutes
  • Parameters
  • Examples
• subtractMonths
  • Parameters
  • Examples
• subtractQuarters
  • Parameters
  • Examples
• subtractSeconds
  • Parameters
  • Examples
• subtractWeeks
  • Parameters
  • Examples
• subtractYears
  • Parameters
  • Examples
• toDate
  • Parameters
  • Examples

Adds days to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• days number the amount of days to add

import { addDays } from 'tempus';

// => input: 2020-11-18 15:30:00
addDays(new Date(2020, 10, 18, 15, 30), 3);
// => output: 2020-11-21 15:30:00

Returns Date the new calculated date

Adds hours to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• hours number the amount of hours to add

import { addHours } from 'tempus';

// => input: 2020-11-18 15:30:00
addHours(new Date(2020, 10, 18, 15, 30), 3);
// => output: 2020-11-18 18:30:00

Returns Date the new calculated date

Adds milliseconds to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• milliseconds number the amount of milliseconds to add

import { addMilliseconds } from 'tempus';

// => input: 1605654000000 ms
addMilliseconds(new Date(2020, 10, 18), 100);
// => output: 1605654000100 ms

Returns Date the new calculated date

Adds minutes to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• minutes number the amount of minutes to add

import { addMinutes } from 'tempus';

// => input: 2020-11-18 15:30:00
addMinutes(new Date(2020, 10, 18, 15, 30), 50);
// => output: 2020-11-18 16:20:00

Returns Date the new calculated date

Adds months to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• months number the amount of months to add

import { addMonths } from 'tempus';

// => input: 2020-11-18 15:30:00
addMonths(new Date(2020, 10, 18, 15, 30), 1);
// => output: 2020-12-18 15:30:00

Returns Date the new calculated date

Adds quarters to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• quarters number the amount of quarters to add

import { addQuarters } from 'tempus';

// => input: 2020-11-18 15:30:00
addQuarters(new Date(2020, 10, 18, 15, 30), 1);
// => output: 2020-02-18 15:30:00

Returns Date the new calculated date

Adds seconds to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• seconds number the amount of seconds to add

import { addSeconds } from 'tempus';

// => input: 1605654000000 ms
addSeconds(new Date(2020, 10, 18), 50);
// => output: 1605654050000 ms

Returns Date the new calculated date

Adds weeks to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• weeks number the amount of weeks to add

import { addWeeks } from 'tempus';

// => input: 2020-11-18 15:30:00
addWeeks(new Date(2020, 10, 18, 15, 30), 1);
// => output: 2020-11-25 15:30:00

Returns Date the new calculated date

Adds years to the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• years number the amount of years to add

import { addYears } from 'tempus';

// => input: 2020-11-18 15:30:00
addYears(new Date(2020, 10, 18, 15, 30), 2);
// => output: 2022-02-18 15:30:00

Returns Date the new calculated date

Calculates the difference between two date objects in days

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInDays } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInDays(value, other);
// => output: 945d

Returns number the difference in days

Calculates the difference between two date objects in hours

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInHours } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInHours(value, other);
// => output: 22676h

Returns number the difference in hours

Calculates the difference between two date objects in milliseconds

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInMilliseconds } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInMilliseconds(value, other);
// => output: 81634545060ms

Returns number the difference in milliseconds

Calculates the difference between two date objects in minutes

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInMinutes } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInMinutes(value, other);
// => output: 1360576min

Returns number the difference in minutes

Calculates the difference between two date objects in months

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInMonths } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInMonths(value, other);
// => output: 31m

Returns number the difference in months

Calculates the difference between two date objects in quarters

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInQuarters } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInQuarters(value, other);
// => output: 10q

Returns number the difference in quarters

Calculates the difference between two date objects in seconds

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInSeconds } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInSeconds(value, other);
// => output: 81634545s

Returns number the difference in seconds

Calculates the difference between two date objects in weeks

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInWeeks } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInWeeks(value, other);
// => output: 135w

Returns number the difference in weeks

Calculates the difference between two date objects in years

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { differenceInYears } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30);
const other = new Date(2018, 3, 18, 20, 15, 0, 0);

differenceInYears(value, other);
// => output: 2y

Returns number the difference in years

Calculates the number of days that passed since start of the year.

• value (Date | number) a date object or a timestamp in milliseconds

import { getDayOfYear } from 'tempus';

// => input: 2020-11-18 15:30:00
getDayOfYear(new Date(2020, 10, 18, 15, 30));
// => output: 323

Returns number the number of days

Calculates the number of quarters that passed since start of the year.

• value (Date | number) a date object or a timestamp in milliseconds

import { getQuarterOfYear } from 'tempus';

// => input: 2020-11-18 15:30:00
getQuarterOfYear(new Date(2020, 10, 18, 15, 30));
// => output: 4

Returns number the number of quarters

Calculates the number of weeks that passed since start of the year.

• value (Date | number) a date object or a timestamp in milliseconds

import { getWeekOfYear } from 'tempus';

// => input: 2020-11-18 15:30:00
getWeekOfYear(new Date(2020, 10, 18, 15, 30));
// => output: 47

Returns number the number of weeks

An interval

Type: Object

• start Date the start of the interval
• end Date the end of the interval

Checks if the first date object is after the second date object.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isAfter } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2019, 11, 6, 16, 35, 50);

isAfter(value, other);
// => output: true

Returns boolean true if the first date is after second date

Checks if the first date object is before the second date object.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isBefore } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2019, 11, 6, 16, 35, 50);

isBefore(value, other);
// => output: false

Returns boolean true if the first date is before second date

Checks if the specified date is in the interval.

• value (Date | number) a date object or a timestamp in milliseconds
• interval Interval the Interval to ckeck

import { isBetween } from 'tempus';

isBetween(new Date(2020, 10, 18, 15, 30, 45), {
    start: new Date(2020, 10, 1),
    end: new Date(2020, 11, 1)
});
// => output: true

Returns boolean true if the date is in the interval

Checks if the specified date has the same amount of days as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentDay } from 'tempus';

isCurrentDay(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date has the same amount of days

Checks if the specified date has the same amount of hours as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentHour } from 'tempus';

isCurrentHour(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date has the same amount of hours

Checks if the specified date has the same amount of minutes as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentMinute } from 'tempus';

isCurrentMinute(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date has the same amount of minutes

Checks if the specified date is in same month as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentMonth } from 'tempus';

isCurrentMonth(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is in same month

Checks if the specified date is in same quarter as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentQuarter } from 'tempus';

isCurrentQuarter(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is in same quarter

Checks if the specified date has the same amount of seconds as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentSecond } from 'tempus';

isCurrentSecond(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date has the same amount of seconds

Checks if the specified date is in same week as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentWeek } from 'tempus';

isCurrentWeek(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is in same week

Checks if the specified date has the same weekday as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentWeekday } from 'tempus';

isCurrentWeekday(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date has the same weekday

Checks if the specified date is in same year as the current date.

• value (Date | number) a date object or a timestamp in milliseconds

import { isCurrentYear } from 'tempus';

isCurrentYear(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is in same year

Checks if an object is an instance of Date.

• value any the object to check

Returns boolean true if the object is a date

Checks if two date objects are equal.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isEqual } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isEqual(value, other);
// => output: true

Returns boolean true if the dates are equal

Checks if the specified date is on a friday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isFriday } from 'tempus';

// => input: 2020-11-18 15:30:00
isFriday(new Date(2020, 10, 18, 15, 30));
// => output: false

Returns boolean true if the date is on a friday

Checks if the specified date is in the future.

• value (Date | number) a date object or a timestamp in milliseconds

import { isFuture } from 'tempus';

isFuture(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is in the future

Checks if the specified date is in a leap year.

• value (Date | number) a date object or a timestamp in milliseconds

import { isLeapYear } from 'tempus';

// => input: 2020-11-18 15:30:00
isLeapYear(new Date(2020, 10, 18, 15, 30));
// => output: true

Returns boolean true if the date is in a leap year

Checks if the specified date is on a monday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isMonday } from 'tempus';

// => input: 2020-11-18 15:30:00
isMonday(new Date(2020, 10, 18, 15, 30));
// => output: false

Returns boolean true if the date is on a monday

Checks if the specified date is in the past.

• value (Date | number) a date object or a timestamp in milliseconds

import { isPast } from 'tempus';

isPast(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is in the past

Checks if two date objects have the same amount of days.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameDay } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameDay(value, other);
// => output: true

Returns boolean true if the dates have the same amount of days

Checks if two date objects have the same amount of hours.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameHour } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameHour(value, other);
// => output: true

Returns boolean true if the dates have the same amount of hours

Checks if two date objects have the same amount of minutes.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameMinute } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameMinute(value, other);
// => output: true

Returns boolean true if the dates have the same amount of minutes

Checks if two date objects are in the same month.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameMonth } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameMonth(value, other);
// => output: true

Returns boolean true if the dates are in the same month

Checks if two date objects are in the same quarter.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameQuarter } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameQuarter(value, other);
// => output: true

Returns boolean true if the dates are in the same quarter

Checks if two date objects have the same amount of seconds.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameSecond } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameSecond(value, other);
// => output: true

Returns boolean true if the dates have the same amount of seconds

Checks if two date objects are in the same week.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameWeek } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameWeek(value, other);
// => output: true

Returns boolean true if the dates are in the same week

Checks if two date objects have the same weekday.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameWeekday } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameWeekday(value, other);
// => output: true

Returns boolean true if the dates have the same amount of weekday

Checks if two date objects are in the same year.

• value (Date | number) a date object or a timestamp in milliseconds
• other (Date | number) a date object or a timestamp in milliseconds

import { isSameYear } from 'tempus';

const value = new Date(2020, 10, 18, 15, 30, 45);
const other = new Date(2020, 10, 18, 15, 30, 45);

isSameYear(value, other);
// => output: true

Returns boolean true if the dates are in the same year

Checks if the specified date is on a saturday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isSaturday } from 'tempus';

// => input: 2020-11-18 15:30:00
isSaturday(new Date(2020, 10, 18, 15, 30));
// => output: false

Returns boolean true if the date is on a saturday

Checks if the specified date is on a sunday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isSunday } from 'tempus';

// => input: 2020-11-18 15:30:00
isSunday(new Date(2020, 10, 18, 15, 30));
// => output: false

Returns boolean true if the date is on a sunday

Checks if the specified date is on a thursday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isThursday } from 'tempus';

// => input: 2020-11-18 15:30:00
isThursday(new Date(2020, 10, 18, 15, 30));
// => output: true

Returns boolean true if the date is on a thursday

Checks if the specified date is tomorrow.

• value (Date | number) a date object or a timestamp in milliseconds

import { isTomorrow } from 'tempus';

isTomorrow(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is tomorrow

Checks if the specified date is on a tuesday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isTuesday } from 'tempus';

// => input: 2020-11-18 15:30:00
isTuesday(new Date(2020, 10, 18, 15, 30));
// => output: false

Returns boolean true if the date is on a tuesday

Checks if the specified date is on a wednesday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isWednesday } from 'tempus';

// => input: 2020-11-18 15:30:00
isWednesday(new Date(2020, 10, 18, 15, 30));
// => output: false

Returns boolean true if the date is on a wednesday

Checks if the specified date is yesterday.

• value (Date | number) a date object or a timestamp in milliseconds

import { isYesterday } from 'tempus';

isYesterday(new Date(2020, 10, 18, 15, 30, 45));

Returns boolean true if the date is yesterday

Selects the maximum date in an array of dates.

• values Date an array of date objects

import { max } from 'tempus';

const dates = [
    new Date(2020, 0, 30, 15, 30, 45),
    new Date(2020, 5, 25, 15, 30, 45),
];

max(dates);
// => output: 2020-06-05 15:30:45

Returns Date the maximum date object

Selects the minimum date in an array of dates.

• values Date an array of date objects

import { min } from 'tempus';

const dates = [
    new Date(2020, 0, 30, 15, 30, 45),
    new Date(2020, 5, 25, 15, 30, 45),
];

min(dates);
// => output: 2020-01-30 15:30:45

Returns Date the minimum date object

Subtracts days from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• days number the amount of days to add

import { subtractDays } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractDays(new Date(2020, 10, 18, 15, 30), 3);
// => output: 2020-11-15 15:30:00

Returns Date the new calculated date

Subtracts hours from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• hours number the amount of hours to add

import { subtractHours } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractHours(new Date(2020, 10, 18, 15, 30), 3);
// => output: 2020-11-18 12:30:00

Returns Date the new calculated date

Subtracts milliseconds from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• milliseconds number the amount of milliseconds to add

import { subtractMilliseconds } from 'tempus';

// => input: 1605654000000 ms
subtractMilliseconds(new Date(2020, 10, 18), 100);
// => output: 1605653999900 ms

Returns Date the new calculated date

Subtracts minutes from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• minutes number the amount of minutes to add

import { subtractMinutes } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractMinutes(new Date(2020, 10, 18, 15, 30), 50);
// => output: 2020-11-18 14:40:00

Returns Date the new calculated date

Subtracts months from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• months number the amount of months to add

import { subtractMonths } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractMonths(new Date(2020, 10, 18, 15, 30), 1);
// => output: 2020-10-18 15:30:00

Returns Date the new calculated date

Subtracts quarters from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• quarters number the amount of quarters to add

import { subtractQuarters } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractQuarters(new Date(2020, 10, 18, 15, 30), 1);
// => output: 2020-08-18 15:30:00

Returns Date the new calculated date

Subtracts seconds from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• seconds number the amount of seconds to add

import { subtractSeconds } from 'tempus';

// => input: 1605653950000 ms
subtractSeconds(new Date(2020, 10, 18), 50);
// => output: 1605654050000 ms

Returns Date the new calculated date

Subtracts weeks from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• weeks number the amount of weeks to add

import { addWeeks } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractWeeks(new Date(2020, 10, 18, 15, 30), 1);
// => output: 2020-11-11 15:30:00

Returns Date the new calculated date

Subtracts years from the date object and returns a new instance, so the original object stays unchanged.

• value (Date | number) a date object or a timestamp in milliseconds
• years number the amount of years to add

import { subtractYears } from 'tempus';

// => input: 2020-11-18 15:30:00
subtractYears(new Date(2020, 10, 18, 15, 30), 2);
// => output: 2022-02-18 15:30:00

Returns Date the new calculated date

Converts any type to a date object. If the specified value is already a date, it returns just the value. If the value is a number, it will be converted with Date(milliseconds) constuctor. If the value anything else, a invalid date will be returned.

• value any the type to convert to a date

import { toDate } from 'tempus';

// => input: 2020-11-18 15:30:00
toDate(new Date(2020, 10, 18, 15, 30));
// => output: 2020-11-18 15:30:00

// => input: 1605709845060
toDate(1605709845060);
// => output: 2020-11-18 15:30:00

// => input: "Hello World"
toDate("Hello World");
// => output: Date(NaN) => Invalid date

Returns Date the converted date object