@ciwergrp/nuxid 1.6.2 → 1.6.3

package/docs/.docs/helpers/date.md

@@ -0,0 +1,702 @@
+---
+title: Date Helpers
+outline: [2, 3]
+---
+
+# Date Helpers
+
+Date helpers are available via `dt()` in factory style, or as prefixed functions (e.g. `Now()`, `DateFormat()`).
+Most functions use `date-fns` and normalize input via `toDate()`.
+
+Factory style:
+
+```ts
+const now = dt().now()
+```
+
+Prefix style:
+
+```ts
+const now = Now()
+```
+
+## Methods
+
+### dt
+Summary: Factory accessor that returns the date helper object.
+Parameters: none.
+- Returns: `DateHelper`.
+- Simple usage: `const d = dt().now()` = `new Date()`
+- Advanced usage: `const formatted = dt().format('2024-01-01', 'YYYY-MM-DD')` = `'2024-01-01'`
+
+### toDate
+Summary: Normalizes input into a `Date` using parsing rules.
+Parameters: `value` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().toDate('2024-01-01')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().toDate('1704067200')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### toUnix
+Summary: Converts input to Unix seconds using `getTime()`.
+Parameters: `value` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().toUnix('2024-01-01')` = `1704067200`
+- Advanced usage: `dt().toUnix('2024-01-01T00:00:00Z')` = `1704067200`
+
+### toMillis
+Summary: Converts input to milliseconds using `getTime()`.
+Parameters: `value` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().toMillis('2024-01-01')` = `1704067200000`
+- Advanced usage: `dt().toMillis('2024-01-01T00:00:00Z')` = `1704067200000`
+
+### fromUnix
+Summary: Creates a `Date` from Unix seconds.
+Parameters: `value` (number | string).
+- Returns: `Date`.
+- Simple usage: `dt().fromUnix(1704067200)` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().fromUnix('1704067200')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### fromTimestamp
+Summary: Alias of `fromUnix` for timestamp seconds.
+Parameters: `value` (number | string).
+- Returns: `Date`.
+- Simple usage: `dt().fromTimestamp(1704067200)` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().fromTimestamp('1704067200')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### now
+Summary: Returns the current `Date`.
+Parameters: none.
+- Returns: `Date`.
+- Simple usage: `dt().now()` = `new Date()`
+- Advanced usage: `dt().now().toISOString()` = `'2024-01-01T00:00:00.000Z'`
+
+### today
+Summary: Returns start of today using `startOfToday`.
+Parameters: none.
+- Returns: `Date`.
+- Simple usage: `dt().today().toISOString().slice(0, 10)` = `'2024-01-01'`
+- Advanced usage: `dt().today().toISOString()` = `'2024-01-01T00:00:00.000Z'`
+
+### tomorrow
+Summary: Returns start of tomorrow using `startOfTomorrow`.
+Parameters: none.
+- Returns: `Date`.
+- Simple usage: `dt().tomorrow().toISOString().slice(0, 10)` = `'2024-01-02'`
+- Advanced usage: `dt().tomorrow().toISOString()` = `'2024-01-02T00:00:00.000Z'`
+
+### yesterday
+Summary: Returns start of yesterday using `startOfYesterday`.
+Parameters: none.
+- Returns: `Date`.
+- Simple usage: `dt().yesterday().toISOString().slice(0, 10)` = `'2023-12-31'`
+- Advanced usage: `dt().yesterday().toISOString()` = `'2023-12-31T00:00:00.000Z'`
+
+### format
+Summary: Formats a date using a preset map and `date-fns` `format`.
+Parameters: `date` (Date | string | number), `formatString` (DateFormatPreset | string), `options` (FormatOptions, optional).
+- Returns: `string`.
+- Simple usage: `dt().format('2024-01-01', 'YYYY-MM-DD')` = `'2024-01-01'`
+- Advanced usage: `dt().format('2024-01-01T00:00:00Z', 'YYYY-MM-DD HH:mm:ss')` = `'2024-01-01 00:00:00'`
+
+### dateFormat
+Summary: Prefix-style alias of `format` for non-factory usage.
+Parameters: `date` (Date | string | number), `formatString` (DateFormatPreset | string), `options` (FormatOptions, optional).
+- Returns: `string`.
+- Simple usage: `DateFormat('2024-01-01', 'YYYY-MM-DD')` = `'2024-01-01'`
+- Advanced usage: `DateFormat('2024-01-01T00:00:00Z', 'YYYY/MM/DD HH:mm')` = `'2024/01/01 00:00'`
+
+### formatISO
+Summary: Formats an ISO string using `date-fns` `formatISO`.
+Parameters: `date` (Date | string | number), `options` (FormatISOOptions, optional).
+- Returns: `string`.
+- Simple usage: `dt().formatISO('2024-01-01')` = `'2024-01-01T00:00:00Z'`
+- Advanced usage: `dt().formatISO('2024-01-01', { representation: 'date' })` = `'2024-01-01'`
+
+### formatRFC3339
+Summary: Formats an RFC3339 string using `date-fns`.
+Parameters: `date` (Date | string | number), `options` (FormatRFC3339Options, optional).
+- Returns: `string`.
+- Simple usage: `dt().formatRFC3339('2024-01-01')` = `'2024-01-01T00:00:00Z'`
+- Advanced usage: `dt().formatRFC3339('2024-01-01', { fractionDigits: 3 })` = `'2024-01-01T00:00:00.000Z'`
+
+### formatRFC7231
+Summary: Formats an RFC7231 string using `date-fns`.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().formatRFC7231('2024-01-01')` = `'Mon, 01 Jan 2024 00:00:00 GMT'`
+- Advanced usage: `dt().formatRFC7231('2024-01-01T00:00:00Z')` = `'Mon, 01 Jan 2024 00:00:00 GMT'`
+
+### fromNow
+Summary: Produces a relative time string from now.
+Parameters: `date` (Date | string | number), `options` (FormatDistanceToNowOptions, optional).
+- Returns: `string`.
+- Simple usage: `dt().fromNow('2024-01-01')` = `'in about 1 hour'`
+- Advanced usage: `dt().fromNow('2024-01-01T00:00:30Z', { includeSeconds: true })` = `'less than a minute'`
+
+### diffForHumans
+Summary: Produces a relative time string between two dates.
+Parameters: `date` (Date | string | number), `baseDate` (Date | string | number, optional), `options` (FormatDistanceOptions, optional).
+- Returns: `string`.
+- Simple usage: `dt().diffForHumans('2024-01-01')` = `'about 1 month'`
+- Advanced usage: `dt().diffForHumans('2024-01-01', '2024-02-01')` = `'about 1 month'`
+
+### toDateString
+Summary: Formats as `YYYY-MM-DD`.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().toDateString('2024-01-01T10:00:00Z')` = `'2024-01-01'`
+- Advanced usage: `dt().toDateString('2024-01-01T00:00:00Z')` = `'2024-01-01'`
+
+### toTimeString
+Summary: Formats as `HH:mm:ss`.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().toTimeString('2024-01-01T10:00:00Z')` = `'10:00:00'`
+- Advanced usage: `dt().toTimeString('2024-01-01T00:00:00Z')` = `'00:00:00'`
+
+### toDateTimeString
+Summary: Formats as `YYYY-MM-DD HH:mm:ss`.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().toDateTimeString('2024-01-01T10:00:00Z')` = `'2024-01-01 10:00:00'`
+- Advanced usage: `dt().toDateTimeString('2024-01-01T00:00:00Z')` = `'2024-01-01 00:00:00'`
+
+### toIsoString
+Summary: Formats as ISO string using `formatISO`.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().toIsoString('2024-01-01')` = `'2024-01-01T00:00:00Z'`
+- Advanced usage: `dt().toIsoString('2024-01-01T00:00:00Z')` = `'2024-01-01T00:00:00Z'`
+
+### toRfc3339String
+Summary: Formats as RFC3339 string.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().toRfc3339String('2024-01-01')` = `'2024-01-01T00:00:00Z'`
+- Advanced usage: `dt().toRfc3339String('2024-01-01T00:00:00Z')` = `'2024-01-01T00:00:00Z'`
+
+### toRfc7231String
+Summary: Formats as RFC7231 string.
+Parameters: `date` (Date | string | number).
+- Returns: `string`.
+- Simple usage: `dt().toRfc7231String('2024-01-01')` = `'Mon, 01 Jan 2024 00:00:00 GMT'`
+- Advanced usage: `dt().toRfc7231String('2024-01-01T00:00:00Z')` = `'Mon, 01 Jan 2024 00:00:00 GMT'`
+
+### parse
+Summary: Parses a string using a format preset and base date.
+Parameters: `value` (string), `formatString` (DateFormatPreset | string), `baseDate` (Date | string | number, optional), `options` (ParseOptions, optional).
+- Returns: `Date`.
+- Simple usage: `dt().parse('2024-01-01', 'YYYY-MM-DD')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().parse('01/02/2024', 'DD/MM/YYYY', new Date('2024-01-01'))` = `new Date('2024-02-01T00:00:00.000Z')`
+
+### dateParse
+Summary: Prefix-style alias of `parse` for non-factory usage.
+Parameters: `value` (string), `formatString` (DateFormatPreset | string), `baseDate` (Date | string | number, optional), `options` (ParseOptions, optional).
+- Returns: `Date`.
+- Simple usage: `DateParse('2024-01-01', 'YYYY-MM-DD')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `DateParse('01/02/2024', 'DD/MM/YYYY', new Date('2024-01-01'))` = `new Date('2024-02-01T00:00:00.000Z')`
+
+### parseISO
+Summary: Parses ISO strings using `date-fns` `parseISO`.
+Parameters: `value` (string).
+- Returns: `Date`.
+- Simple usage: `dt().parseISO('2024-01-01')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().parseISO('2024-01-01T10:00:00Z')` = `new Date('2024-01-01T10:00:00.000Z')`
+
+### addSeconds
+Summary: Adds seconds using `date-fns` `addSeconds`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addSeconds('2024-01-01T00:00:00Z', 30)` = `new Date('2024-01-01T00:00:30.000Z')`
+- Advanced usage: `dt().addSeconds('2024-01-01T00:00:00Z', 120)` = `new Date('2024-01-01T00:02:00.000Z')`
+
+### addSecond
+Summary: Adds one second via `addSeconds`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addSecond('2024-01-01T00:00:00Z')` = `new Date('2024-01-01T00:00:01.000Z')`
+- Advanced usage: `dt().addSecond('2024-01-01T00:00:00Z')` = `new Date('2024-01-01T00:00:01.000Z')`
+
+### addMinutes
+Summary: Adds minutes using `date-fns` `addMinutes`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addMinutes('2024-01-01T00:00:00Z', 15)` = `new Date('2024-01-01T00:15:00.000Z')`
+- Advanced usage: `dt().addMinutes('2024-01-01T00:00:00Z', 90)` = `new Date('2024-01-01T01:30:00.000Z')`
+
+### addMinute
+Summary: Adds one minute via `addMinutes`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addMinute('2024-01-01T00:00:00Z')` = `new Date('2024-01-01T00:01:00.000Z')`
+- Advanced usage: `dt().addMinute('2024-01-01T00:00:00Z')` = `new Date('2024-01-01T00:01:00.000Z')`
+
+### addHours
+Summary: Adds hours using `date-fns` `addHours`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addHours('2024-01-01T00:00:00Z', 2)` = `new Date('2024-01-01T02:00:00.000Z')`
+- Advanced usage: `dt().addHours('2024-01-01T00:00:00Z', 6)` = `new Date('2024-01-01T06:00:00.000Z')`
+
+### addHour
+Summary: Adds one hour via `addHours`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addHour('2024-01-01T00:00:00Z')` = `new Date('2024-01-01T01:00:00.000Z')`
+- Advanced usage: `dt().addHour('2024-01-01T00:00:00Z')` = `new Date('2024-01-01T01:00:00.000Z')`
+
+### addDays
+Summary: Adds days using `date-fns` `addDays`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addDays('2024-01-01', 7)` = `new Date('2024-01-08T00:00:00.000Z')`
+- Advanced usage: `dt().addDays('2024-01-01', 30)` = `new Date('2024-01-31T00:00:00.000Z')`
+
+### addDay
+Summary: Adds one day via `addDays`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addDay('2024-01-01')` = `new Date('2024-01-02T00:00:00.000Z')`
+- Advanced usage: `dt().addDay('2024-01-01')` = `new Date('2024-01-02T00:00:00.000Z')`
+
+### addWeeks
+Summary: Adds weeks using `date-fns` `addWeeks`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addWeeks('2024-01-01', 2)` = `new Date('2024-01-15T00:00:00.000Z')`
+- Advanced usage: `dt().addWeeks('2024-01-01', 4)` = `new Date('2024-01-29T00:00:00.000Z')`
+
+### addWeek
+Summary: Adds one week via `addWeeks`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addWeek('2024-01-01')` = `new Date('2024-01-08T00:00:00.000Z')`
+- Advanced usage: `dt().addWeek('2024-01-01')` = `new Date('2024-01-08T00:00:00.000Z')`
+
+### addMonths
+Summary: Adds months using `date-fns` `addMonths`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addMonths('2024-01-01', 1)` = `new Date('2024-02-01T00:00:00.000Z')`
+- Advanced usage: `dt().addMonths('2024-01-01', 6)` = `new Date('2024-07-01T00:00:00.000Z')`
+
+### addMonth
+Summary: Adds one month via `addMonths`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addMonth('2024-01-01')` = `new Date('2024-02-01T00:00:00.000Z')`
+- Advanced usage: `dt().addMonth('2024-01-01')` = `new Date('2024-02-01T00:00:00.000Z')`
+
+### addYears
+Summary: Adds years using `date-fns` `addYears`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().addYears('2024-01-01', 1)` = `new Date('2025-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().addYears('2024-01-01', 5)` = `new Date('2029-01-01T00:00:00.000Z')`
+
+### addYear
+Summary: Adds one year via `addYears`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().addYear('2024-01-01')` = `new Date('2025-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().addYear('2024-01-01')` = `new Date('2025-01-01T00:00:00.000Z')`
+
+### subSeconds
+Summary: Subtracts seconds using `date-fns` `subSeconds`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subSeconds('2024-01-01T00:01:00Z', 30)` = `new Date('2024-01-01T00:00:30.000Z')`
+- Advanced usage: `dt().subSeconds('2024-01-01T00:02:00Z', 120)` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### subSecond
+Summary: Subtracts one second via `subSeconds`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subSecond('2024-01-01T00:00:00Z')` = `new Date('2023-12-31T23:59:59.000Z')`
+- Advanced usage: `dt().subSecond('2024-01-01T00:00:00Z')` = `new Date('2023-12-31T23:59:59.000Z')`
+
+### subMinutes
+Summary: Subtracts minutes using `date-fns` `subMinutes`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subMinutes('2024-01-01T01:00:00Z', 15)` = `new Date('2024-01-01T00:45:00.000Z')`
+- Advanced usage: `dt().subMinutes('2024-01-01T01:30:00Z', 90)` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### subMinute
+Summary: Subtracts one minute via `subMinutes`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subMinute('2024-01-01T00:00:00Z')` = `new Date('2023-12-31T23:59:00.000Z')`
+- Advanced usage: `dt().subMinute('2024-01-01T00:00:00Z')` = `new Date('2023-12-31T23:59:00.000Z')`
+
+### subHours
+Summary: Subtracts hours using `date-fns` `subHours`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subHours('2024-01-01T12:00:00Z', 2)` = `new Date('2024-01-01T10:00:00.000Z')`
+- Advanced usage: `dt().subHours('2024-01-01T06:00:00Z', 6)` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### subHour
+Summary: Subtracts one hour via `subHours`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subHour('2024-01-01T00:00:00Z')` = `new Date('2023-12-31T23:00:00.000Z')`
+- Advanced usage: `dt().subHour('2024-01-01T00:00:00Z')` = `new Date('2023-12-31T23:00:00.000Z')`
+
+### subDays
+Summary: Subtracts days using `date-fns` `subDays`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subDays('2024-01-01', 7)` = `new Date('2023-12-25T00:00:00.000Z')`
+- Advanced usage: `dt().subDays('2024-01-01', 30)` = `new Date('2023-12-02T00:00:00.000Z')`
+
+### subDay
+Summary: Subtracts one day via `subDays`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subDay('2024-01-01')` = `new Date('2023-12-31T00:00:00.000Z')`
+- Advanced usage: `dt().subDay('2024-01-01')` = `new Date('2023-12-31T00:00:00.000Z')`
+
+### subWeeks
+Summary: Subtracts weeks using `date-fns` `subWeeks`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subWeeks('2024-01-01', 2)` = `new Date('2023-12-18T00:00:00.000Z')`
+- Advanced usage: `dt().subWeeks('2024-01-01', 4)` = `new Date('2023-12-04T00:00:00.000Z')`
+
+### subWeek
+Summary: Subtracts one week via `subWeeks`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subWeek('2024-01-01')` = `new Date('2023-12-25T00:00:00.000Z')`
+- Advanced usage: `dt().subWeek('2024-01-01')` = `new Date('2023-12-25T00:00:00.000Z')`
+
+### subMonths
+Summary: Subtracts months using `date-fns` `subMonths`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subMonths('2024-01-01', 1)` = `new Date('2023-12-01T00:00:00.000Z')`
+- Advanced usage: `dt().subMonths('2024-01-01', 6)` = `new Date('2023-07-01T00:00:00.000Z')`
+
+### subMonth
+Summary: Subtracts one month via `subMonths`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subMonth('2024-01-01')` = `new Date('2023-12-01T00:00:00.000Z')`
+- Advanced usage: `dt().subMonth('2024-01-01')` = `new Date('2023-12-01T00:00:00.000Z')`
+
+### subYears
+Summary: Subtracts years using `date-fns` `subYears`.
+Parameters: `date` (Date | string | number), `amount` (number).
+- Returns: `Date`.
+- Simple usage: `dt().subYears('2024-01-01', 1)` = `new Date('2023-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().subYears('2024-01-01', 5)` = `new Date('2019-01-01T00:00:00.000Z')`
+
+### subYear
+Summary: Subtracts one year via `subYears`.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().subYear('2024-01-01')` = `new Date('2023-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().subYear('2024-01-01')` = `new Date('2023-01-01T00:00:00.000Z')`
+
+### startOfSecond
+Summary: Returns the start of the second.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfSecond('2024-01-01T00:00:00.999Z')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().startOfSecond('2024-01-01T00:00:00.999Z')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### endOfSecond
+Summary: Returns the end of the second.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfSecond('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T00:00:00.999Z')`
+- Advanced usage: `dt().endOfSecond('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T00:00:00.999Z')`
+
+### startOfMinute
+Summary: Returns the start of the minute.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfMinute('2024-01-01T00:00:59.999Z')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().startOfMinute('2024-01-01T00:00:59.999Z')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### endOfMinute
+Summary: Returns the end of the minute.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfMinute('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T00:00:59.999Z')`
+- Advanced usage: `dt().endOfMinute('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T00:00:59.999Z')`
+
+### startOfHour
+Summary: Returns the start of the hour.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfHour('2024-01-01T23:59:59.999Z')` = `new Date('2024-01-01T23:00:00.000Z')`
+- Advanced usage: `dt().startOfHour('2024-01-01T23:59:59.999Z')` = `new Date('2024-01-01T23:00:00.000Z')`
+
+### endOfHour
+Summary: Returns the end of the hour.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfHour('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T00:59:59.999Z')`
+- Advanced usage: `dt().endOfHour('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T00:59:59.999Z')`
+
+### startOfDay
+Summary: Returns the start of the day.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfDay('2024-01-01T23:59:59.999Z')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().startOfDay('2024-01-01T23:59:59.999Z')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### endOfDay
+Summary: Returns the end of the day.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfDay('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T23:59:59.999Z')`
+- Advanced usage: `dt().endOfDay('2024-01-01T00:00:00.001Z')` = `new Date('2024-01-01T23:59:59.999Z')`
+
+### startOfWeek
+Summary: Returns the start of the week.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfWeek('2024-01-01')` = `new Date('2023-12-31T00:00:00.000Z')`
+- Advanced usage: `dt().startOfWeek('2024-01-01')` = `new Date('2023-12-31T00:00:00.000Z')`
+
+### endOfWeek
+Summary: Returns the end of the week.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfWeek('2024-01-01')` = `new Date('2024-01-06T23:59:59.999Z')`
+- Advanced usage: `dt().endOfWeek('2024-01-01')` = `new Date('2024-01-06T23:59:59.999Z')`
+
+### startOfMonth
+Summary: Returns the start of the month.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfMonth('2024-01-15')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().startOfMonth('2024-01-15')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### endOfMonth
+Summary: Returns the end of the month.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfMonth('2024-01-15')` = `new Date('2024-01-31T23:59:59.999Z')`
+- Advanced usage: `dt().endOfMonth('2024-01-15')` = `new Date('2024-01-31T23:59:59.999Z')`
+
+### startOfQuarter
+Summary: Returns the start of the quarter.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfQuarter('2024-02-01')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().startOfQuarter('2024-02-01')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### endOfQuarter
+Summary: Returns the end of the quarter.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfQuarter('2024-02-01')` = `new Date('2024-03-31T23:59:59.999Z')`
+- Advanced usage: `dt().endOfQuarter('2024-02-01')` = `new Date('2024-03-31T23:59:59.999Z')`
+
+### startOfYear
+Summary: Returns the start of the year.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().startOfYear('2024-06-01')` = `new Date('2024-01-01T00:00:00.000Z')`
+- Advanced usage: `dt().startOfYear('2024-06-01')` = `new Date('2024-01-01T00:00:00.000Z')`
+
+### endOfYear
+Summary: Returns the end of the year.
+Parameters: `date` (Date | string | number).
+- Returns: `Date`.
+- Simple usage: `dt().endOfYear('2024-06-01')` = `new Date('2024-12-31T23:59:59.999Z')`
+- Advanced usage: `dt().endOfYear('2024-06-01')` = `new Date('2024-12-31T23:59:59.999Z')`
+
+### diffInSeconds
+Summary: Returns difference in seconds using `differenceInSeconds`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInSeconds('2024-01-01T00:00:00Z', '2024-01-01T00:01:00Z')` = `60`
+- Advanced usage: `dt().diffInSeconds('2024-01-01T00:00:00Z', '2024-01-01T00:00:01Z')` = `1`
+
+### diffInMinutes
+Summary: Returns difference in minutes using `differenceInMinutes`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInMinutes('2024-01-01T00:00:00Z', '2024-01-02T00:00:00Z')` = `1440`
+- Advanced usage: `dt().diffInMinutes('2024-01-01T00:00:00Z', '2024-01-01T00:01:00Z')` = `1`
+
+### diffInHours
+Summary: Returns difference in hours using `differenceInHours`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInHours('2024-01-01T00:00:00Z', '2024-01-02T00:00:00Z')` = `24`
+- Advanced usage: `dt().diffInHours('2024-01-01T00:00:00Z', '2024-01-01T01:00:00Z')` = `1`
+
+### diffInDays
+Summary: Returns difference in days using `differenceInDays`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInDays('2024-01-01', '2024-02-01')` = `31`
+- Advanced usage: `dt().diffInDays('2024-01-01', '2024-01-02')` = `1`
+
+### diffInWeeks
+Summary: Returns difference in weeks using `differenceInWeeks`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInWeeks('2024-01-01', '2024-02-01')` = `4`
+- Advanced usage: `dt().diffInWeeks('2024-01-01', '2024-01-08')` = `1`
+
+### diffInMonths
+Summary: Returns difference in months using `differenceInMonths`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInMonths('2024-01-01', '2024-03-01')` = `2`
+- Advanced usage: `dt().diffInMonths('2024-01-01', '2023-01-01')` = `12`
+
+### diffInYears
+Summary: Returns difference in years using `differenceInYears`.
+Parameters: `dateLeft` (Date | string | number), `dateRight` (Date | string | number).
+- Returns: `number`.
+- Simple usage: `dt().diffInYears('2020-01-01', '2024-01-01')` = `4`
+- Advanced usage: `dt().diffInYears('2010-01-01', '2024-01-01')` = `14`
+
+### isBefore
+Summary: Checks if a date is before another.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isBefore('2024-01-01', '2024-02-01')` = `true`
+- Advanced usage: `dt().isBefore('2024-01-01T00:00:00Z', '2024-01-01T00:00:01Z')` = `true`
+
+### isAfter
+Summary: Checks if a date is after another.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isAfter('2024-02-01', '2024-01-01')` = `true`
+- Advanced usage: `dt().isAfter('2024-01-01T00:00:01Z', '2024-01-01T00:00:00Z')` = `true`
+
+### isEqual
+Summary: Checks if two dates are equal.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isEqual('2024-01-01', '2024-01-01')` = `true`
+- Advanced usage: `dt().isEqual('1970-01-01T00:00:00Z', 0)` = `true`
+
+### isSameSecond
+Summary: Checks if two dates are in the same second.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameSecond('2024-01-01T00:00:00Z', '2024-01-01T00:00:00Z')` = `true`
+- Advanced usage: `dt().isSameSecond('2024-01-01T00:00:00Z', '2024-01-01T00:00:00Z')` = `true`
+
+### isSameMinute
+Summary: Checks if two dates are in the same minute.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameMinute('2024-01-01T00:00:00Z', '2024-01-01T00:00:30Z')` = `true`
+- Advanced usage: `dt().isSameMinute('2024-01-01T00:00:00Z', '2024-01-01T00:00:30Z')` = `true`
+
+### isSameHour
+Summary: Checks if two dates are in the same hour.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameHour('2024-01-01T10:00:00Z', '2024-01-01T10:59:59Z')` = `true`
+- Advanced usage: `dt().isSameHour('2024-01-01T10:00:00Z', '2024-01-01T10:59:59Z')` = `true`
+
+### isSameDay
+Summary: Checks if two dates are on the same day.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameDay('2024-01-01T00:00:00Z', '2024-01-01T23:59:59Z')` = `true`
+- Advanced usage: `dt().isSameDay('2024-01-01T00:00:00Z', '2024-01-01T23:59:59Z')` = `true`
+
+### isSameWeek
+Summary: Checks if two dates are in the same week.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameWeek('2024-01-01', '2024-01-07')` = `true`
+- Advanced usage: `dt().isSameWeek('2024-01-01', '2024-01-07')` = `true`
+
+### isSameMonth
+Summary: Checks if two dates are in the same month.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameMonth('2024-01-01', '2024-01-31')` = `true`
+- Advanced usage: `dt().isSameMonth('2024-01-01', '2024-01-31')` = `true`
+
+### isSameYear
+Summary: Checks if two dates are in the same year.
+Parameters: `date` (Date | string | number), `dateToCompare` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isSameYear('2024-01-01', '2024-12-31')` = `true`
+- Advanced usage: `dt().isSameYear('2024-01-01', '2024-12-31')` = `true`
+
+### isToday
+Summary: Checks if the date is today.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isToday('2024-01-01')` = `true`
+- Advanced usage: `dt().isToday('2024-01-02')` = `false`
+
+### isTomorrow
+Summary: Checks if the date is tomorrow.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isTomorrow('2024-01-02')` = `true`
+- Advanced usage: `dt().isTomorrow('2024-01-01')` = `false`
+
+### isYesterday
+Summary: Checks if the date is yesterday.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isYesterday('2023-12-31')` = `true`
+- Advanced usage: `dt().isYesterday('2024-01-01')` = `false`
+
+### isWeekend
+Summary: Checks if the date is on a weekend.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isWeekend('2024-01-06')` = `true`
+- Advanced usage: `dt().isWeekend('2024-01-07')` = `true`
+
+### isPast
+Summary: Checks if the date is in the past.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isPast('2020-01-01')` = `true`
+- Advanced usage: `dt().isPast('2024-01-01T00:00:00Z')` = `true`
+
+### isFuture
+Summary: Checks if the date is in the future.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isFuture('2999-01-01')` = `true`
+- Advanced usage: `dt().isFuture('2025-01-01')` = `true`
+
+### isThisWeek
+Summary: Checks if the date is in the current week.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isThisWeek('2024-01-01')` = `true`
+- Advanced usage: `dt().isThisWeek('2023-12-01')` = `false`
+
+### isThisMonth
+Summary: Checks if the date is in the current month.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isThisMonth('2024-01-15')` = `true`
+- Advanced usage: `dt().isThisMonth('2024-01-15')` = `true`
+
+### isThisYear
+Summary: Checks if the date is in the current year.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isThisYear('2024-06-01')` = `true`
+- Advanced usage: `dt().isThisYear('2024-06-01')` = `true`
+
+### isValid
+Summary: Checks if a date is valid.
+Parameters: `date` (Date | string | number).
+- Returns: `boolean`.
+- Simple usage: `dt().isValid('2024-01-01')` = `true`
+- Advanced usage: `dt().isValid('invalid-date')` = `false`