useDate API

Exposed

(date: unknown, amount: number) => unknown

(date: unknown, amount: number) => unknown

(date: unknown, amount: number) => unknown

(date: unknown, amount: number) => unknown

(date: unknown, amount: number) => unknown

(value: any) => unknown

(date: unknown) => unknown

(date: unknown) => unknown

(date: unknown) => unknown

(date: unknown) => unknown

(date: unknown, formatString: string) => string

(date: unknown) => number

(date: unknown, comparing: unknown, unit: string) => number

(date: unknown) => number

(date: unknown) => number

(date: unknown) => number

(date: unknown) => unknown

(date: unknown) => unknown

(
  date: unknown,
  firstDayOfWeek: string | number,
  firstDayOfYear: string | number,
) => number

(date: unknown, firstDayOfWeek: string | number) => unknown[][]

(
  firstDayOfWeek: string | number,
  weekdayFormat: 'long' | 'short' | 'narrow',
) => string[]

(date: unknown) => number

(date: unknown, comparing: unknown) => boolean

(date: unknown, comparing: unknown) => boolean

(date: unknown, comparing: unknown) => boolean

(date: unknown, comparing: unknown) => boolean

(date: unknown, comparing: unknown) => boolean

(date: unknown, comparing: unknown) => boolean

(date: unknown, comparing: unknown) => boolean

(date: any) => boolean

(date: unknown, range: [unknown, unknown]) => boolean

any

(date: string) => unknown

(date: unknown, day: number) => unknown

(date: unknown, hours: number) => unknown

(date: unknown, minutes: number) => unknown

(date: unknown, month: number) => unknown

(date: unknown, year: number) => unknown

(date: unknown) => unknown

(date: unknown) => unknown

(date: unknown, firstDayOfWeek: string | number) => unknown

(date: unknown) => unknown

(date: unknown) => string

(value: unknown) => Date

`addDays`
Adds the specified number of days to the date.
`addHours`
Adds the specified number of hours to the date.
`addMinutes`
Adds the specified number of minutes to the date.
`addMonths`
Adds the specified number of months to the date.
`addWeeks`
Adds the specified number of weeks to the date.
`date`
Takes any value and returns a date object.
`endOfDay`
Returns the last second of the day.
`endOfMonth`
Returns the last day of the month.
`endOfWeek`
Returns the last day of the week.
`endOfYear`
Returns the last day of the year.
`format`
Takes a date object and returns it in a specified format.
`getDate`
Returns the day of the month of the date.
`getDiff`
Returns the difference between two dates in the specified unit.
`getHours`
Returns the hours of the day of the date.
`getMinutes`
Returns the minutes of the hour of the date.
`getMonth`
Returns the month of the date.
`getNextMonth`
Returns the next month of the date.
`getPreviousMonth`
Returns the previous month of the date.
`getWeek`
Returns the week of the year of the date.
`getWeekArray`
Returns an array of the days of the week of the date.
`getWeekdays`
Returns an array of the names of the days of the week.
`getYear`
Returns the year of the date.
`isAfter`
Returns true if the first date is after the second date.
`isAfterDay`
Returns true if the first date is after the second date.
`isBefore`
Returns true if the first date is before the second date.
`isEqual`
Returns true if the two dates are equal.
`isSameDay`
Returns true if the two dates are the same day.
`isSameMonth`
Returns true if the two dates are the same month.
`isSameYear`
Returns true if the two dates are the same year.
`isValid`
Returns true if the date is valid.
`isWithinRange`
Returns true if the first date is within the range of the second and third dates.
`locale`
Returns the current locale being used.
`parseISO`
Parses a date string in ISO format.
`setDate`
Sets the day of the date.
`setHours`
Sets the hours of the date.
`setMinutes`
Sets the minutes of the date.
`setMonth`
Sets the month of the date.
`setYear`
Sets the year of the date.
`startOfDay`
Returns the first second of the day.
`startOfMonth`
Returns first day of the month.
`startOfWeek`
Returns the first day of the week.
`startOfYear`
Returns the first day of the year.
`toISO`
Converts date value to a ISO Date Object.
`toJsDate`
Converts date value to a JS Date Object.

#useDate API

useDate API